2010-10-08 31 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