phpdoc：记录常量的正确方法是什么

Question

是否有正确的方法来记录使用define()定义的常量？ @var真的没有意义。我唯一能想到的是省略标签，只需在PHPdoc评论中写下描述。

Answer 1

phpDocumentor无法识别或使用@const标记。当phpDocumentor在代码中看到“define”关键字时，它会识别一个常量。它的输出模板将显示输出文档中的所有常量，列为常量。 constant的docblock中唯一需要的是描述，尽管如果你觉得你需要它们，可以使用许多其他“标准”标签[1]。

[1] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_elements.pkg.html#procedural.define

Answer 2

使用@const。

/**
  * @const FOO Bar
  */
define('FOO', 'Bar');

Documentation（对不起，我能找到的唯一文档是德语。）

Answer 3

您实际上想要使用@type，请参阅Github PHP Documentation。