如何在phpdoc中记录私有变量

Question

我试图在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两者都没有在文档中来.

Answer 1

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

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

见http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.access.pkg.html