This is the doxygen documentation style we have chosen for Drake CMS:
## Documentation for this module. # # More details. ## Documentation for a function. # # @param $n The number passed as parameter # More details. function example($n) { echo "I have $n years"; } ## Documentation for a class. # # More details. class MyClass { ## @var _memVar # a member variable var $_memVar; ## The constructor. function MyClass() { $this->_memVar = 0; } ## Documentation for a method. # @param $s The string to display function MyMethod($s) { echo $s; } }
Inline comments to explain complex code blocks are also wanted.