Documenting design and code
-
I am looking for suggestions regarding a tool (commercial or free) that I can use to better document the Visual C++ project I have been working on for the last two years. I am familiar with UML and have tried UML Studio from Rogue Wave. However, I need to document more than just the class diagrams. I am not looking for any silver bullets - I know the task ahead of me is considerable and will require much effort whichever tool gets used. I'm looking particularly for diagramming capability, with integration with VC6 if poss. I have around 300 classes, around 100000 lines of code, and need to get the knowledge in my head disseminated in a form other programmers can use. The app makes heavy use of multiple threads and producing a model of this behaviour is paramount. Mark Jones Software Engineer Hampshire UK
-
I am looking for suggestions regarding a tool (commercial or free) that I can use to better document the Visual C++ project I have been working on for the last two years. I am familiar with UML and have tried UML Studio from Rogue Wave. However, I need to document more than just the class diagrams. I am not looking for any silver bullets - I know the task ahead of me is considerable and will require much effort whichever tool gets used. I'm looking particularly for diagramming capability, with integration with VC6 if poss. I have around 300 classes, around 100000 lines of code, and need to get the knowledge in my head disseminated in a form other programmers can use. The app makes heavy use of multiple threads and producing a model of this behaviour is paramount. Mark Jones Software Engineer Hampshire UK
I can recommend to look at doxygen or doc++ (I prefer the former). It gives you ability to document your classes in the source code and then just produce html documentation out of source code. Let me know if find anything better. proskig@hotmail.com Igor Proskuriakov