是否定义()语句需要phpDocumentor样式的文档块？

时间：2015-03-31 作者：henrywright

这方面没有消息WordPress Documentation Standards, 但确实如此define() 语句需要phpDocumentor样式的docblocks？

/**
 * Should this docblock be here?
 *
 * @since 1.0.0
 */
define( \'MY_CONST\', \'Hello\' );


// Or would a comment be more appropriate?
define( \'MY_CONST\', \'Hello\' );
作为参考，标准文件中提到的待停靠元素列表如下：

函数和类方法类类属性要求并包括钩子（操作和筛选器）内联注释文件头常量

1 个回复
最合适的回答,由SO网友:Nicolai Grossherr 整理而成

我想说的是Constants 在Wordpress: PHP Documentation Standards 非常清楚。应该是这样的：

/**
 * Summary.
 *
 * @since x.x.x (if available)
 * @var type $var Description.
 */
define( \'MY_CONST\', \'Hello\' );

结束
标签： documentation   coding-standards   小码农  

相关推荐

Buddypress Full documentation

我已经搜索了很多关于buddypress挂钩（操作、过滤器）和函数的完整文档列表，但对提供的有限文档并不满意Buddypress.如果我想知道bp_directory_groups_search_form() 没有关于这种方法的具体细节，buddypress-hook也是如此。。。所以任何人都知道完整文档的确切位置。