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

Question

我有这样的代码：

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

我不认为使用@var是一个恒定的正确，我没有看到任何@constant PHPDoc的标签。什么是正确的方法来做到这一点？

Answer 1

为了让他们进入PHPDoc的，使用方法：

@const THING 

常用的结构：

@const[ant] label [description] 

Answer 2

@const是不正确的答案。

• 这不是传统的phpDocumentor文档的一部分：http://manual.phpdoc.org/HTMLframesConverter/default/
• 这不是当前的phpDocumentor文档的一部分：http://www.phpdoc.org/docs/latest/index.html
• 它不是在标签的列表中列出的维基百科：http://en.wikipedia.org/wiki/PHPDoc#Tags
• 未列出在PHP-FIG草案PSR中：https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md#7-tags

列出的唯一的“官方”地方是phpdoc.de，但规范只存在于使其1.0beta，该网站还包括@brother和@sister，这是我以前从未见过的标签，所以该网站的整体信任有所减少;-)事实上 标准一直是phpDoc.org 。

总之，即使一些非官方的标准没有提及它，如果文档生成器不支持它，那么它是不值得使用的。

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

Answer 3

我使用Netbeans。当使用这种格式将分析全球和类常量PHPDoc的：

/** @const Global constant description */ 
define('MY_CONST', 10); 

class MyClass 
{ 
    /** @const Class constant description */ 
    const MY_CONST = 10; 
} 

Answer 4

The PHP-FIG suggests using @var for constants.

7.22。@var

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

• 常量，既类和全球范围
• 属性
• 变量，包括全球和本地范围

语法

个

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

Answer 5

以下proposition方面the official documentation syntax：

class Foo 
{ 
    const 
     /** 
     * @var string Should contain a description 
     */ 
     MY_CONST1 = "1", 
     /** 
     * @var string Should contain a description 
     */ 
     MY_CONST2 = "2"; 

}