Jump to content

PHP Documentation


kickassamd

Recommended Posts

How about phpDocumentor?

 

Example:

<?php
/**
* Bla bla bla description of TestClass and its usage.
*
* @author John Doe
* @package Test
* @since 21 Dec, 2007
*/
class TestClass
{
/**
 * Holds something
 *
 * @access private
 * @var boolean
 */
private $variable;

/**
 * TestMethod uses bla bla and does something
 *
 * @param integer $arg1
 * @param array $array
 * @param boolean $do_something
 * @see TestClass::something()
 */
public function test_method($arg1, array $array, $do_something = false)
{

}

/**
 * Magic 
 *
 * @magic
 * @access public
 */
public function __toString()
{

}

/**
 * Static method which does something
 *
 * @static
 * @access public
 * @return float
 */
public static function static_method()
{

}

/**
 * Enter description here...
 *
 * @final
 * @param string $var
 * @param integer $var2
 * @return string
 */
final protected function something($var, $var2 = null)
{

}
}
?>

Link to comment
https://forums.phpfreaks.com/topic/82747-php-documentation/#findComment-420872
Share on other sites

Archived

This topic is now archived and is closed to further replies.

×
×
  • Create New...

Important Information

We have placed cookies on your device to help make this website better. You can adjust your cookie settings, otherwise we'll assume you're okay to continue.