PHPDocSyntax

From Wikipedia

PHPDOC HEADER 4 FILES

/**
* short description of the file content
*
* feel free to add more comments
* in the next lines here
*
* @package    Projects
* @module     Statistics
* @author     Nina Schmitt, $Author:$
* @licence    GPL, see www.gnu.org/copyleft/gpl.html
* @copyright  2000-2006 Mayflower GmbH www.mayflower.de
* @version    $Id:$
*/
if (!defined('lib_included')) die('Please use index.php!');

PHPDOC HEADER 4 CLASSES

/**
* short description of the class
*
* feel free to add more comments
* in the next lines here
*
*
*/
class class1 () {
/**
* @var int
*/
}

PHPDOC HEADER 4 FUNCTIONS

/**
* short description of the function
*
* feel free to add more comments
* in the next lines here
*
* @param string $par1 name of 1. input variable
* @param string $par2 name of 2. input variable
* @return string
*/
function example($par1 = , $par = ) (
}