Revision [7101]
This is an old revision of DocumentingCodeHowto made by NilsLindenberg on 2005-04-04 12:48:25.
How to document code used in wikka
This page tries to explain the way code is documented in wikka. This should be done to make it easier for other people to understand what the code is doing and why.
Documenting Actions and functions
Every action and function should have a documenting block at its beginning. This could be used, for example, for automatic-generatied documentation.
This block follows the following standard:
Generell
- it begins with a slash and two asterix:
/**
- each line has an asterix at the beginning:
*
- it ends with an asterix and a slash:
*/
Example:
/**
* This is a text.
*
*/
* This is a text.
*
*/
Special Phrases
Special expressions are words with an '@' at the beginning. The following could be used:
@package
@subpackage
@name
@author
@license
@copyright
@version
@input
@output
@uses
@todo
Links
followsTemplate for Actions
not finished<?
/**
* The first sentence should descripe the action and must end with a dot.
*
* Here follows the long version of the description.
*
* Another part of the description.
*
* @package Action
* @subpackage //choose one
* @name //the name of this action
*
* @author
* @license
* @copyright
* @version
*
* @input
* @output
*
* @uses
* @todo
*/
/**
* The first sentence should descripe the action and must end with a dot.
*
* Here follows the long version of the description.
*
* Another part of the description.
*
* @package Action
* @subpackage //choose one
* @name //the name of this action
*
* @author
* @license
* @copyright
* @version
*
* @input
* @output
*
* @uses
* @todo
*/
more follows
CategoryHowto
