2010-10-08 82 views
19

如何为phpDoc记录类常量?我已阅读手册,但找不到有关它们的任何内容。phpDoc类常量文档

+1

使用'@ var'是正确的做法,请参阅https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#722-var – m13r 2017-04-11 05:42:16

回答

10

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

+0

我不知道为什么它没有记录,但它似乎工作,谢谢... – mck89 2010-10-08 16:06:01

+6

更好地审查'@ const'文档在这里:http://stackoverflow.com/a/18446766/367456 - 它也解释说,没有这样的事情存在。 – hakre 2014-08-12 18:12:43

+3

应根据此答案使用'@ var':http://stackoverflow.com/a/27772200/2053165 – Leith 2016-08-05 04:37:34

29

常量只需要包含说明的文档块。没有具体的标签是必要的。代码解析器本身标识常量,并将其显示在生成的文档中(here's an example)。

+2

这似乎适用于[phpDocumentor](http://phpdoc.org/),但告诉Netbeans哪些描述要在自动完成中显示,必须按照其他答案中的描述添加'@ const'。 – feeela 2013-03-06 09:31:39

+0

以下是我使用的内容:http://stackoverflow.com/a/24042505/244826 – Sonny 2014-06-18 12:43:19