Sign in to follow this  
nooan

Advices on code commenting

Recommended Posts

Hello, In my engine I need to add documentation, in the form of code comments, to all my header files (hundreds of...) The documentation for each function includes a brief description of its usage and of its parameters and return values. Not only functions but other objects like classes have to be commented. Now, since this is a HUGE work to do, before starting I would appreciate the advice of people here on a suggested format. The possibility of automatically extracting a documentation file from the code by parsing the comments is a big bonus.I know .NET promotes in-code documentation in XML format, but I'm also aware of other formats (like the Doxygen one). Any advices on this matter? Thanks a lot, Stefano

Share this post


Link to post
Share on other sites
I've always liked the Javadoc format. It's parseable by Doxygen, Javadoc, and probably other tools as well.
My actual advice: choose a tool you like for documentation extraction, THEN choose a format you like and your tool supports.

Share this post


Link to post
Share on other sites

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

Sign in to follow this