koobas.hobune.stream
General advice on documenting my Unity project
Hi,
So my project is going well at the moment, and I have been doing my best to keep it clean and tidy. Commenting code, making sure code structure is neat, creating code snippets, and keeping general notes in a word document.
However, one thing I am lacking is the ability to document the relationships that my scripts have with each other, or even the general flow of my Unity project as a whole. For example which script gets a variable from another script. I am thinking of some kind of flow chart to do it, but was wondering if anyone has any advice, suggestions, or even software recommendations, on how to do it right ;)
Thanks
Paul
You could look at Doxygen, it is free and generates a html document out of your script comments: http://www.stack.nl/~dimitri/doxygen/
Have you tried doxygen with UnityScript fafase? It looks neat but too automated for me. I am happy doing it all by hand, as it will force me to think about the relationships between scripts while documenting, and may lead to improvements.
I have used it once long ago. It generates Html pages or Pdf. It is actually automated. You need to write down all the info respecting the convention and it does the rest. You still have to write it all, doxygen only makes it look nice. For flowchart like class flowchart, well Dia or any database related thing would do.
Yeah, it's pretty much what I thought ;)
Seeing as now one else has come up with a better answer I'll for vote yours. Thanks for advice!
