How to document class properties in PHP 5 with phpDocumentor
I would generally use at least the @var
tag, to indicate the type of variable this is.
For instance :
/**
* Some blah blah about what this is useful for
* @var MyClass $foo
*/
This is exactly what's done by Zend Framework, for instance ; see Zend_Layout
(quoting) :
class Zend_Layout
{
/**
* Placeholder container for layout variables
* @var Zend_View_Helper_Placeholder_Container
*/
protected $_container;
/**
* Key used to store content from 'default' named response segment
* @var string
*/
protected $_contentKey = 'content';
Note : the @access
tag was useful with PHP 4 (when there were no public
/protected
/private
), but I never use it when I document code written in PHP 5 : the code, using the visibility keywords is self-documenting.
/**
* This is what the variable does. The var line contains the type stored in this variable.
* @var string
*/
private $foo;