PHP 注釋標(biāo)記

@access
使用范圍：class,function,var,define,module
該標(biāo)記用于指明關(guān)鍵字的存取權(quán)限：private、public或proteced

@author
指明作者

@copyright
使用范圍：class，function，var，define，module，use
指明版權(quán)信息

@deprecated
使用范圍：class，function，var，define，module，constent，global，include
指明不用或者廢棄的關(guān)鍵字

@example
該標(biāo)記用于解析一段文件內(nèi)容，并將他們高亮顯示。Phpdoc會試圖從該標(biāo)記給的文件路徑中讀取文件內(nèi)容

@const
使用范圍：define
用來指明php中define的常量

@final
使用范圍：class,function,var
指明關(guān)鍵字是一個最終的類、方法、屬性，禁止派生、修改。

@filesource
和example類似，只不過該標(biāo)記將直接讀取當(dāng)前解析的php文件的內(nèi)容并顯示。

@global
指明在此函數(shù)中引用的全局變量

@ingore
用于在文檔中忽略指定的關(guān)鍵字

@license
相當(dāng)于html標(biāo)簽中的<a>,首先是URL，接著是要顯示的內(nèi)容
例如<a href=”http://www.baidu.com”>百度</a>
可以寫作 @license http://www.baidu.com 百度

@link
類似于license
但還可以通過link指到文檔中的任何一個關(guān)鍵字

@name
為關(guān)鍵字指定一個別名。

@package
使用范圍：頁面級別的-> define，function，include
類級別的->class，var，methods
用于邏輯上將一個或幾個關(guān)鍵字分到一組。

@abstrcut
說明當(dāng)前類是一個抽象類

@param
指明一個函數(shù)的參數(shù)

@return
指明一個方法或函數(shù)的返回指

@static
指明關(guān)建字是靜態(tài)的。

@var
指明變量類型

@version
指明版本信息

@todo
指明應(yīng)該改進(jìn)或沒有實(shí)現(xiàn)的地方

@throws
指明此函數(shù)可能拋出的錯誤異常,極其發(fā)生的情況

普通的文檔標(biāo)記標(biāo)記必須在每行的開頭以@標(biāo)記，除此之外，還有一種標(biāo)記叫做inline tag,用{@}表示，具體包括以下幾種：

{@link}
用法同@link

{@source}
顯示一段函數(shù)或方法的內(nèi)容

注釋規(guī)范

a.注釋必須是

/**
* 注釋內(nèi)容
*/

的形式

b.對于引用了全局變量的函數(shù)，必須使用glboal標(biāo)記。

c.對于變量，必須用var標(biāo)記其類型（int,string,bool…）

d.函數(shù)必須通過param和return標(biāo)記指明其參數(shù)和返回值

e.對于出現(xiàn)兩次或兩次以上的關(guān)鍵字，要通過ingore忽略掉多余的，只保留一個即可

f.調(diào)用了其他函數(shù)或類的地方，要使用link或其他標(biāo)記鏈接到相應(yīng)的部分，便于文檔的閱讀。

g.必要的地方使用非文檔性注釋，提高代碼易讀性。

h.描述性內(nèi)容盡量簡明扼要，盡可能使用短語而非句子。

i.全局變量，靜態(tài)變量和常量必須用相應(yīng)標(biāo)記說明

最新評論