如何在 phpdoc 中记录私有变量

发布于 2024-10-19 15:24:08 字数 363 浏览 5 评论 0原文

我试图在 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 都没有出现在文档中。

I am trying to document the private variable in phpdoc but its not documenting.

Here is my code:

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

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

The $_db and $_s3 both are not coming in documentation.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

鲜肉鲜肉永远不皱 2024-10-26 15:24:08

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

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

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

That's what supposed to happen - setting @access private prevents the following code block from appearing in the documentation.

To get it to appear you need to use the command line switch --parseprivate

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

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文