Few programmers enjoy writing software documentation, though the quality of their lamentations on the subject indicates that many are talented writers. Good source code documentation takes time and effort, and it’s essential, so what’s an overworked coder to do? Look for tools to make it easier, like the Doxygen documentation system. Doxygen generates documentation directly from source code. It supports multiple output formats, such as HTML, PDF, RTF, man pages, and LaTeX. It works out-of-the-box with C++, C, Java, Objective-C, Python, IDL, Fortran, VHDL, PHP, C#, and D, and community members have written helpers for other languages such as Perl, JavaScript, Visual Basic, Object Pascal, VB.Net, and TCL.
|
|