search

haxwell / quizki

A question and answer database that generates exams.
http://www.quizki.com
GNU General Public License v2.0
4 stars 14 forks source link

objectAid class diagram generator test #211

Closed jdisser closed 6 years ago

jdisser commented 6 years ago

I installed the ObjectAid plugin and generated a class diagram for the entities with simple drag and drop from the Navigator onto the diagram. I think the diagram is helpful for seeing the dependencies and an easy to follow reference for each class. I put the new diagram in the Doc folder, it's the only change to the repo. From the objectAid doc the diagram will automatically change when changes are made to the code. You can zoom out to 25% and get a good overview of all the dependencies.

Wish I had something like this on that other job I mentioned!

haxwell commented 6 years ago

Hi Jim.. Sorry for the delay, finally took a look at ObjectAid.. I agree, something like this could be useful. I have two reservations.. First, its not open source. Second, its specific to Eclipse. Perhaps you could add a section in the DEVELOPER file, Useful Tools or the like.. and then describe this tool there. Whaddaya think?

jdisser commented 6 years ago

The best solution would be independent of the IDE. I think intellij has the ability to create diagrams built in(!) see here https://www.jetbrains.com/help/idea/working-with-diagrams.html#d878201e21 It looks like Netbeans also supports UML diagrams with a tool called the modelling pack http://wiki.netbeans.org/NetbeansUML and here just for a (in)sanity check is what I turned up seeking the holy grail, something that runs in all three https://www.visual-paradigm.com/features/code-engineering-tools/ now for only $99 :-( ... they do have a $6/mo subscription but this is not exactly the grail. Definitely not open source. There does not appear to be an easy way to store the diagram in a standard format. XMI should work that way but it's not really supported by the IDE plugins that handle the diagrams. So the only "U"niversal answer is the commercial $6/mo Visual-paradigm route (which actually does a lot more cool stuff than diagrams). It would generate XMI files too but the other tools don't import them so it will not work even as a work around. I guess the next best thing would be to document how to generate diagrams in each IDE and not include the diagrams in git. I would be happy to write the Useful Tools doc for Eclipse/ObjectAid and leave the other IDE's for the team.

haxwell commented 6 years ago

Just to clear up my "Pull Request To-Do List", I'm going to close this PR.. It will still be available in history if you want to reference it or add to it later.

jdisser commented 6 years ago

I have not found a really good solution for this that would work on all the different platforms for free. I was thinking about that question Brian asked during the planning meeting about a starting point to learn the codebase. A class diagram like this might work. I found I gained a much better understanding of the app by studying the Entities. The tool you talked about for displaying the schema is probably the closest thing to a universal tool to make that easier to do.

On Apr 25, 2018, at 9:15 AM, Johnathan James notifications@github.com wrote:

Closed #211 https://github.com/haxwell/quizki/pull/211.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/haxwell/quizki/pull/211#event-1594349297, or mute the thread https://github.com/notifications/unsubscribe-auth/ANoxUf7YblynlpgriPGuQUoX7wF9PzTgks5tsJMJgaJpZM4S9rnz.