Jump to content

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

This thread is more than a year old. Please don't revive it unless you have something important to add.

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Restore formatting

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
×
  • 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.