Thread Rating:
  • 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
07-10-2005, 12:47 PM,
Have you ever played with doxygen? It's an automatic documentation creation tool, it can make docs from your source code. It creates HTML or linked PDFs. All you have to do is write descriptions of your functions and variables before each one's definiton. It does all sorts of neat stuff and makes a complete API, class and function reference for a project, which is of course quite handy when coding.
07-10-2005, 02:27 PM,
Nope, haven't played around with it. I'm sure it would be helpful in the long run, although I'm to the point in my coding now where I don't even bother to put in comments most of the time (it's all in my memory) -- which is probably a bad thing, although I can code super fast.... So, for it to be helpful I'd have to go back and add tons of comments.I'll think about it... I know it's a good idea, just need to find the time....
07-10-2005, 03:59 PM,
I think when I worked with it last we only really had to document the header files. I think function descriptions have to go before the actual functions, though maybe there's an option to change that. Doxygen still throws together a stub for the function that shows you the parameters it takes, and shows your class structure and things like that, even if you don't have comments. Maybe when there's some kinda revision control set up I will play around with it.

Forum Jump:

Users browsing this thread: 1 Guest(s)