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,用{@}表示,具體包括以下幾種:


習慣的註釋例子:

/**
 * 方法介紹
 * 
 * @param $param1, int 參數含義
 * @param $param2, string 參數含義
 * @return boolean 返回值含義
 */
 
 function func1($param1, $param2){
 	// your code here ...
 	return 'something';
 }



發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章