Hi Dyk, This is likely an unpopular answer, but in my opinion asking a software program to explain your software code to another programmer won't be very effective. As others have pointed out, there are software packages out there that will do the diagramming, snatch up the function comments (assuming they are tagged correctly), etc. All of this is very nice, but in the end if you want someone else to understand your work (and have a shot at maintaining it vs. rewriting it), there's no substitute for writing:
-A document describing the high-level modules, their purpose and inter-relationships -A comment at the top of each source file explaining what its for -A comment at the top of each function explaining what its for -Generous comments sprinkled throughout your code If these are being done, then I think the tools can add value by gathering this info together into a cohesive document, and showing inter-relationships. The tools by themselves are not enough. I think I read this from somewhere a long time ago (too clever for me to have written): "Comment your code well, and the poor developer that has to debug and maintain your code in two years will thank you. That developer may even be you." Best regards, Glenn -----Original Message----- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]]On Behalf Of Dyk Corman Sent: Wednesday, April 10, 2002 5:42 AM To: Palm Developer Forum Subject: Documentation of Code .. any Software packages available? Hi! Since I wrote my Palm Application as one part of my master thesis, I would like (and have to) write a good and detailed documentation so that the code can be maintained from someone else. Does anybody know good software to do that, e.g. generate graphs from the code that show the relationship of all the functions,... I found some good open-source projects like http://www.stack.nl/~dimitri/doxygen/ but would like to know what most developers for Palm use... Many Thanks, Dyk -- For information on using the Palm Developer Forums, or to unsubscribe, please see http://www.palmos.com/dev/support/forums/ -- For information on using the Palm Developer Forums, or to unsubscribe, please see http://www.palmos.com/dev/support/forums/
