爲常量編寫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"; 

}