phpdoc：什麼是證明常數的正確方法

Question

有沒有一種合適的方法來記錄使用define()定義的常量？ @var真的沒有道理。我能想到的唯一的事情就是省略標籤，並在PHPdoc評論中寫下描述。

Answer 1

phpDocumentor的不承認或利用@const標籤。 phpDocumentor在代碼中看到「define」關鍵字時就會識別出一個常量。其輸出模板將顯示輸出文檔中的所有常量，列爲常量。常數的docblock中唯一需要的是描述，儘管如果你覺得你需要它們，許多其他的「標準」標籤都是允許的[1]。

[1] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_elements.pkg.html#procedural.define

Answer 2

使用@const。

/** 
    * @const FOO Bar 
    */ 
define('FOO', 'Bar'); 

Documentation（對不起，唯一的文檔我能看到的是德語。）

Answer 3

你真的想使用@type，看到Github PHP Documentation。