statements ()语句需要phpDocumentor样式的docblocks吗？

Question

在WordPress文档标准中没有这个词，但是define()语句需要phpDocumentor样式的文档块吗？

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


// Or would a comment be more appropriate?
define( 'MY_CONST', 'Hello' );

作为参考，标准文档中提到的要停靠块的元素列表如下：

• 函数和类方法
• 类
• 类属性
• 要求并包括
• 钩子(动作和过滤器)
• 内联注释
• 文件头
• 常量

Answer 1

我想说，常量部分在Wordpress: PHP文档标准中是相当清楚的。它应该是这样的：

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