Documenting

Published August 28, 2004
Advertisement
For those of you that don't know, I spend some of my time at work programming medical software for the treatment ideas my group comes up with. Recently, I have had to write my code so that one of my students can use the libraries I write.

I have used most of the major documenting tools on the market, both free and otherwise, and find that it is almost impossible to write comments that are legible in both the source code and the documentation, finding that arcane means are required to get the style I need.

Yann L seemed to be having a similar problem, and one of the replies he got (I can't seem to find the thread in question) told him to use NaturalDocs.

After some initial annoyance (directories with spaces in seem to confuse it) I found it wonderful - mainly because it used a similar "english" way of laying things out to the way I was doing it before.

As my hands are getting less useful, this saves me a huge amount of post-documentation work[grin]
Previous Entry Post- or Pre-Increment
Next Entry New Horizons
0 likes 1 comments

Comments

evolutional
I love NaturalDocs, I'm using it in most of my projects to date [grin]
August 28, 2004 02:39 PM
You must log in to join the conversation.
Don't have a GameDev.net account? Sign up!
Profile
Author
Advertisement
Advertisement