PHPDOC

When documenting in phpdoc, use the following datatypes. If no appropriate datatype is listed, use mixed as a wildcard and explain in the comments.

Valid data types:

• • string (Also used when char)

  • int (Integer)

  • bool (Boolean)

  • float (Floating point, double)

  • array

  • object (User defined and PHP defined objects)

  • resources (DB resources ect.)

  • NULL

  • mixed (if various types are possible)

  • number (int and float - Can be used, but NOT recommended - NOT a valid PHP type)

Use @uses when documenting a class that extends another class.

Document all classes, functions, class vars, class methods.

Use @category, @package, @subpackage.

Use the short description to give quick explanation of functionality.

Use long description to give useful information about functionality. DO not give long description to gettes and setter etc.

Always document parameters and return values. Document type as precise as possible.

PHPDOC templates for JANUS