首頁  >  文章  >  後端開發  >  php 註解規範

php 註解規範

高洛峰
高洛峰原創
2016-12-01 09:42:36979瀏覽

@access 
使用範圍:class,function,var,define,module 
此標記用於指明關鍵字的存取權:private、public或proteced 
@author 
指明作者 
@copyright 
@author 
指明作者 
@copyright 
@author 
指明作者 
@copyright 
@author 
指明作者 
@copyright 
@ ,var,define,module,use 
指明版權資訊 
@deprecated 
使用範圍:class,function,var,define,module,constent,global,include 
使用範圍:class,function,var,define,module,constent,global,include 
使用或廢棄的關鍵字解析一段文件內容,並將他們高亮顯示。 Phpdoc會試圖從該標記給的文件路徑中讀取文件內容 
@const 
使用範圍:define 
用來指明php中define的常數 
@final 
使用範圍:class,function,var 
@final 
使用範圍:class,function,var
最終的類別、方法、屬性,禁止派生、修改。 
@filesource 
和example類似,只不過該標記將直接讀取目前解析的php檔案的內容並顯示。
@global 
指明在此函數中引用的全域變數 
@ingore 
用於在文件中忽略指定的關鍵字 
@license 
相當於html標籤中的,首先是URL,接著是要顯示的內容 
例如
可以寫作@license http://www.baidu.com 百度 
@link 
類似於license 
但也可以透過link指到文檔中的任何一個關鍵字 
@name 
為關鍵字指定一個別名。 
@package 
使用範圍:頁面層級的-> define,function,include 
類別層級的->class,var,methods 
用於邏輯上將一個或幾個關鍵字分到一組。 
@abstrcut 
說明目前類別是一個抽象類別 
@param 
指明一個函數的參數 
@return 
指明一個方法或函數的回傳指 
@static 。
@var 
指明變數類型 
@version 
指明版本資訊 

@todo 🎜指明應該改善或沒有實現的地方 🎜@throws 🎜指明此異常函數、極度發生的錯誤普通的文檔標記標記必須在每行的開頭以@標記,除此之外,還有一種標記叫做inline tag,用{@}表示,具體包括以下幾種: 🎜{@link} 🎜用法同@link 🎜{@source} 🎜顯示一段函數或方法的內容🎜
陳述:
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn