Code Documentation Examples and Tools
Doxygen Home Page
Think that documenting your code is all black and white? Think that there is one "right" way? Think that
all developers are in agreement? Think you can call yourself a professional without knowing how to properly
document your code? Think again. This "religious" issue was
debated on slashdot
a while ago.
There is an excellent help file that is included with Doxygen. It explains everything you need to know
to use Doxygen. You'll find it in the directory where Doxygen is installed. (It's in the Start menu as well.)
- The documentation for the Halflife
SDK created with Doxygen.
- GLT documentation GLT is an OpenGL C++ Toolkit
- Still not convinced Doxygen can help you?
A Big List of projects that have been documented
- There are lots of other documentation tools available such as
There's a list of free and commercial products
- Literate Programming Interestingly, this concept has been
around for about 20 years.
From the FAQ:
"In general, literate programs combine source and documentation in a single file. Literate
programming tools then parse the file to produce either readable documentation or compilable source."
From Donald Knuth:
"Let us change our traditional attitude to the construction of programs: Instead of imagining
that our main task is to instruct a computer what to do, let us concentrate rather on explaining
to human beings what we want a computer to do."
- Tools for Literate Programming Doxygen is just
one of dozens of tools for professional developers. There are many other very powerful (some FREE!) tools
for communicating your code to humans.