为常量编写 PHPDocs 的正确方法是什么？

php phpdoc

2022-08-30 08:02:44

我有这个代码：

/**
 * Days to parse
 * @var int
 */
const DAYS_TO_PARSE = 10;
...

我不认为使用常量是正确的，我没有看到任何PHPDoc标签。正确的方法是什么？@var@constant

答案 1

7.22.@var

您可以使用标签来记录以下“结构元素”的“类型”：@var

常量，包括类和全局范围

性能

变量，全局和局部范围

语法

@var ["Type"] [element_name] [<description>]

答案 2

@const不是正确的答案。

它列出的唯一“官方”地方是 phpdoc.de，但那里的规格只达到了1.0beta，该网站还包括像和这样的标签，我以前从未见过使用过，所以对该网站的整体信任度有所降低;-）事实上的标准一直是 phpDoc.org。@brother@sister

简而言之，即使一些非官方标准确实提到了它，如果文档生成器不支持它，那么它就不值得使用。

@var现在是正确的，一旦PSR（上面列表中的最后一个链接）退出草案，并且是phpDocumentor，Doxygen，APIGen和其他人理解PHPDoc的基础，那么@type将是正确的，这是@var的继承者。