php註釋標準

/**
 * @name 名字
 * @abstract 申明變量/類/方法
 * @access 指明這個變量、類、函數/方法的存取權限
 * @author 函數做者的名字和郵箱地址
 * @category 組織packages
 * @copyright 指明版權信息
 * @const 指明常量
 * @deprecate 指明不推薦或者是廢棄的信息
 * @example 示例
 * @exclude 指明當前的註釋將不進行分析，不出如今文擋中
 * @final 指明這是一個最終的類、方法、屬性，禁止派生、修改。
 * @global 指明在此函數中引用的全局變量
 * @include 指明包含的文件的信息
 * @link 定義在線鏈接
 * @module 定義歸屬的模塊信息
 * @modulegroup 定義歸屬的模塊組
 * @package 定義歸屬的包的信息
 * @param 定義函數或者方法的參數信息
 * @return 定義函數或者方法的返回信息
 * @see 定義須要參考的函數、變量，並加入相應的超級鏈接。
 * @since 指明該api函數或者方法是從哪一個版本開始引入的
 * @static 指明變量、類、函數是靜態的。
 * @throws 指明此函數可能拋出的錯誤異常,極其發生的狀況
 * @todo 指明應該改進或沒有實現的地方
 * @var 定義說明變量/屬性。
 * @version 定義版本信息
 */

  文檔標記的使用範圍是指該標記能夠用來修飾的關鍵字，或其餘文檔標記。
全部的文檔標記都是在每一行的 * 後面以@開頭。若是在一段話的中間出來@的標記，這個標記將會被當作普通內容而被忽略掉。

@access
使用範圍：class,function,var,define,module
該標記用於指明關鍵字的存取權限：private、public或proteced

@author
指明做者

@copyright
使用範圍：class，function，var，define，module，use
指明版權信息

@deprecated
使用範圍：class，function，var，define，module，constent，global，include
指明不用或者廢棄的關鍵字

@example
該標記用於解析一段文件內容，並將他們高亮顯示。Phpdoc會試圖從該標記給的文件路徑中讀取文件內容

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

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

@filesource
和example相似，只不過該標記將直接讀取當前解析的php文件的內容並顯示。

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

@ingore
用於在文檔中忽略指定的關鍵字

@license
至關於html標籤中的,首先是URL，接着是要顯示的內容
例如[url=http://bbs.phpchina.com/」http://www.jigwang.com」]PHP那些事兒[/url]
能夠寫做 @license http://www.jigwang.com PHP那些事兒

@link
相似於license
但還能夠經過link指到文檔中的任何一個關鍵字

@name
爲關鍵字指定一個別名。

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

@abstrcut
說明當前類是一個抽象類

@param
指明一個函數的參數

@return
指明一個方法或函數的返回指

@static
指明關建字是靜態的。

@var
指明變量類型

@version
指明版本信息

@todo
指明應該改進或沒有實現的地方

@throws
指明此函數可能拋出的錯誤異常,極其發生的狀況
上面提到過，普通的文檔標記標記必須在每行的開頭以@標記，除此以外，還有一種標記叫作inline tag,用{@}表示，具體包括如下幾種：

{@link}
用法同@link

{@source}顯示一段函數或方法的內容