文檔標記的使用范圍是指該標記可以用來修飾的關鍵字,或其他文檔標記。
所有的文檔標記都是在每一行的 * 后面以@開頭。如果在一段話的中間出來@的標記,這個標記將會被當做普通內容而被忽略掉。
~~~
@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://blog.emtalk.net/ "http://blog.emtalk.net"]PHP入門學習[/url]
可以寫作 @license http://blog.emtalk.net PHP入門學習
~~~
@link
~~~
該標記類似于license
但還可以通過link指到文檔中的任何一個關鍵字
~~~
@name
~~~
該標記為關鍵字指定一個別名。
~~~
@package
~~~
使用范圍:頁面級別的-> define,function,include
類級別的->class,var,methods
該標記用于邏輯上將一個或幾個關鍵字分到一組。
~~~
@abstrcut
~~~
該標記用于說明當前類是一個抽象類
~~~
@param
~~~
該標記用于指明一個函數的參數
~~~1
@return
~~~
該標記用于指明一個方法或函數的返回指
~~~
@static
~~~
該標記用于指明關建字是靜態的。
~~~
@var
~~~
該標記用于指明變量類型
~~~
@version
~~~
該標記用于指明版本信息
~~~
@todo
~~~
該標記用于指明應該改進或沒有實現的地方
~~~
@throws
~~~
該標記用于指明此函數可能拋出的錯誤異常,極其發生的情況
上面提到過,普通的文檔標記標記必須在每行的開頭以@標記,除此之外,還有一種標記叫做inline tag,用{@}表示,具體包括以下幾種:
{@link}
用法同@link
{@source}
顯示一段函數或方法的內容
范例:
~~~
/**
* @author Author Name [<author@email.com>] 代碼編寫人(負責人)
* @version xx.xx 當前版本號
* @param datatype $v_name[,...] description 函數相關聯的參數,含有,...表示可傳入不定數量的其他參數
* @return datatype description 函數或方法的返回值類型
* @global datatype description 全局變量的說明(僅對phpDocumentor解析器起作用)
* @var datatype 在類中說明類變量(屬性)的類型
* @example [path|url] description 舉一個例子,以闡釋使用方法
* @todo description 待完成的工作信息或待解決的問題信息
*/
~~~