php class and function header documentations

php class and function header documentation example.

<?php
/**
 * An example class to show case
 * php class and function header documentations
 * @author   Joe <joe@test.com>
 * @version  1.0
 */
class Example {
	/**
	 * The function description goes here.
	 * @param integer $a A variable contains an integer
	 * @param string $b A variable contains a string
	 * @param boolean $c A variable contains a boolean value
	 * @param array $d A variable contains an array of elements
	 * @param object $e A variable contains an object
	 * @return integer An random integer 
	 */
	function aFunction($a, $b, $c, $d, $e)
	{
	    $r = rand(); //generate an random integer
	    return $r;
	}	
}

Search within Codexpedia

Custom Search

Search the entire web

Custom Search