phpDoc类常量文档

Question

我如何为phpDoc文档记录类常量？我已经阅读了手册，但没有找到相关内容。

- mck89

---

使用 @var 是正确的方法，详见 https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#722-var - m13r

这回答了你的问题吗？如何正确编写常量的PHPDocs？ - Melebius

Answer 1

常量只需要一个包含描述的文档块。不需要特定的标签。代码解析器本身会识别常量并在生成的文档中显示它们的定义(这里有一个例子)。

- ashnazg

---

这似乎适用于phpDocumentor，但要告诉Netbeans显示哪个描述以进行自动完成，必须按照其他答案中所述添加@const。 - feeela

这是@var，因为@const不存在：https://docs.phpdoc.org/references/phpdoc/index.html - Wade

Answer 2

我相信你可以使用@const，尽管我找不到任何英文文档。这里有一个德国示例，它显示的是define语句而不是类常量，但如果我没记错的话，语法是一样的。

---

九年后，编辑...

现在明确了上述是错误的建议，因为@const没有出现在文档中，而且似乎也不会出现。

使用@var似乎可行，但我无法在任何地方明确指定它。

- lonesomeday

---

这里有一个更好的对@const文档的审查：https://dev59.com/P2w15IYBdhLWcg3wT51c#18446766 - 它还解释了这样的东西不存在。 - hakre

根据这个回答：https://dev59.com/P2w15IYBdhLWcg3wT51c#27772200，应该使用`@var`。 - Leith

又是一个糟糕的选定答案...有可能更改选定的答案吗？我不记得了，但你应该知道... --> 各位，不要使用@const，因为它不是有效的、不正确的，也不在文档中。有一天它可能不起作用，就像被“弃用”一样，但仍然可以工作，直到他们决定拔掉插头。 - Wade

@Wade 或者你可以进行编辑，就像我所做的那样。这就是 StackOverflow 的工作方式。如果你能找到一些关于使用 @var 或者其他最佳解决方案的权威资料，请在答案中添加。 - lonesomeday

Answer 3

所有 PHPDoc 3 标签的完整列表：标签参考

手册 说：

@var

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

• 常量，包括类和全局作用域
• 属性
• 变量，包括全局和局部作用域

- zxdx