phpDoc 类常量文档

Posted 2023-02-22

【中文标题】phpDoc 类常量文档

【英文标题】：phpDoc class constants documentation

【发布时间】：2011-04-22 23:12:09

【问题描述】：

如何记录 phpDoc 的类常量？我已经阅读了手册，但找不到任何关于它们的信息。

【问题讨论】：

使用@var是正确的做法，见github.com/phpDocumentor/fig-standards/blob/master/proposed/…

【参考方案1】：

常量只需要一个包含描述的文档块。不需要特定的标签。代码解析器本身会识别常量并将其显示在生成的文档中 (here's an example)。

【讨论】：

这似乎适用于 phpDocumentor，但要告诉 Netbeans 在自动完成中显示哪个描述，必须添加 @const，如另一个答案中所述。

它是@var，因为@const 不存在：docs.phpdoc.org/references/phpdoc/index.html

【参考方案2】：

我很确定您可以使用@const，尽管我找不到任何英文文档。有一个德国例子here。它显示 define 语句而不是类常量，但 IIRC 的语法是相同的。

---

九年后，一次编辑……

现在很明显，上面的建议是不好的，因为@const 没有出现在文档中，而且似乎不会出现。

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

【讨论】：

对@const 文档的更好评论在这里：***.com/a/18446766/367456 - 它还解释了不存在这样的东西。

应该使用@var 按照这个答案：***.com/a/27772200/2053165

又一个糟糕的选择答案...是否可以更改选择的答案？我不记得了，但你应该.. --> 伙计们，不要使用@const，因为它无效、不正确，并且不在文档中。有一天它可能不起作用，有点像被“弃用”但在他们决定拔掉插头之前仍然有效..

@Wade 或者你可以编辑，就像我所做的那样。这就是 *** 的工作原理。如果您能找到使用@var 或任何最佳解决方案的权威，请将其添加到答案中。