php 注釋規范

2024-05-04 23:15:21

字體：大中小

來源：轉載

供稿：網友

@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標簽中的<a>,首先是URL，接著是要顯示的內容
例如<a href=””>百度</a>
可以寫作 @license 百度
@link
類似于license
但還可以通過link指到文檔中的任何一個關鍵字
@name
為關鍵字指定一個別名。
@package
使用范圍：頁面級別的-> define，function，include
類級別的->class，var，methods
用于邏輯上將一個或幾個關鍵字分到一組。
@abstrcut
說明當前類是一個抽象類
@param
指明一個函數的參數
@return
指明一個方法或函數的返回指
@static
指明關建字是靜態的。
@var
指明變量類型
@version
指明版本信息
@todo
指明應該改進或沒有實現的地方
@throws
指明此函數可能拋出的錯誤異常,極其發生的情況
上面提到過，普通的文檔標記標記必須在每行的開頭以@標記，除此之外，還有一種標記叫做inline tag,用{@}表示，具體包括以下幾種：
{@link}
用法同@link
{@source}
顯示一段函數或方法的內容

上一篇：php提示無法加載或mcrypt沒有找到 PHP 擴展 mbstring解決辦法

下一篇：php 計劃任務檢測用戶連接狀態