Software Documentation
Doxygen (HTML Documentation):
C / C++ / C#
Visual Studio 2008 (Intellisense, ObjectBrowser):
.Net Languages
-> use the following features to ensure working of both systems:
Comment Blocks:
Single Line (preferred for datatype documentations, since better supported by VS)
///////////////////////////////////////////////
/// … text …
///////////////////////////////////////////////
Multiple Line (for Pages, Directory, Module documentation)
/**********************************************
\page
… text text text text text text text
text text text text text text text
text text text text text …
**********************************************/
Use JAVADOC_AUTOBRIEF
Mandatory Commands:
Optional Commands:
<remarks>, <summary>, <example>, <exception>, <param>, <permission>, <returns>, <seealso>, and <include>.
<code>, <list>, <listheader>, <item>, <term>, <description>, <para>, <paramref>, <see>, and <value>.
\page
\file
\namespace