如何在phpdoc中记录私有变量

时间:2011-03-02 09:15:00

标签: php documentation phpdoc

我正在尝试记录phpdoc中的私有变量,但它没有记录。

这是我的代码:

class Content
{
    /**
    * simple db class variable
    * @access private
    */
    var $_db = null; // db
    private $_s3 = null; // s3

    /**
    * queue for mainting session queue1
    */
    public $queue = array();
}

$_db$_s3都没有出现在文档中。

1 个答案:

答案 0 :(得分:9)

这就是应该发生的事情 - 设置@access private会阻止以下代码块出现在文档中。

要使其显示,您需要使用命令行开关--parseprivate

请参阅http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.access.pkg.html