如何使用 phpDocumentor 在 PHP 5 中记录类属性

php class phpdoc

2022-08-30 13:05:56

请考虑以下 PHP 5 类：

class SomeClass
{
    //I want to document this property...
    private $foo;


    function __construct()
    {

    }

    public function SetFoo($value)
    {
        $this->foo = $value;
    }

    public function GetFoo()
    {
        return $this->foo;
    }
}

在phpDocumentor中，我将如何记录$foo属性？我甚至不确定它需要记录下来，但我想知道如果需要，该怎么办...

我知道如何记录SetFoo（）和GetFoo（），我只是不确定私有属性（变量？）。

谢谢！

答案 1

/**
 * This is what the variable does. The var line contains the type stored in this variable.
 * @var string
 */
private $foo;

答案 2

我通常至少使用标签，以指示这是变量的类型。@var

例如：

/**
 * Some blah blah about what this is useful for
 * @var MyClass $foo
 */

例如，这正是Zend Framework所做的;见Zend_Layout（引用）：

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';

注意：这个标签在PHP 4中很有用（当没有公共/受保护/私有时），但是当我记录用PHP 5编写的代码时，我从不使用它：代码，使用可见性关键字是自我记录的。@access