如何在 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
都没有出现在文档中。
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 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
这就是应该发生的事情 - 设置
@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