Jump to content
  • Advertisement
Sign in to follow this  
  • entries
    8
  • comments
    15
  • views
    8821

Documenting

Sign in to follow this  
gregs

291 views

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]
Sign in to follow this  


1 Comment


Recommended Comments

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Advertisement
×

Important Information

By using GameDev.net, you agree to our community Guidelines, Terms of Use, and Privacy Policy.

GameDev.net is your game development community. Create an account for your GameDev Portfolio and participate in the largest developer community in the games industry.

Sign me up!