PHP 註解標記
@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
@example
@example
@example
@example
@example
@example
@example
@example
@example標記用於解析一段文件內容,並將他們高亮顯示。 Phpdoc會試圖從該標記給的檔案路徑中讀取檔案內容
@const
使用範圍:define
用來指明php中define的常數
@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}
顯示一段函數或方法的內容
註釋規範
a.註釋必須是
/**
* 註釋內容
*/
的形式
b.對於引用了全局變數的函數,必須使用glboal標記。
c.對於變量,必須用var標記其類型(int,string,bool…)d.函數必須透過param和return標記指明其參數和傳回值
e.對於出現兩次或兩次以上的關鍵字,要透過ingore忽略掉多餘的,只保留一個即可🎜f.調用了其他函數或類的地方,要使用link或其他標記鏈接到相應的部分,便於文檔的閱讀。 🎜g.必要的地方使用非文檔性註釋,提高程式碼易讀性。 🎜h.描述性內容盡量簡明扼要,盡可能使用短語而非句子。 🎜i.全域變量,靜態變數和常數必須以對應標記說明 🎜 以上就介紹了Delphi中資源檔案 PHP檔案註解標記及規範小結,包括了Delphi中資源檔案方面的內容,希望對PHP教學有興趣的朋友有所幫助。 🎜 🎜 🎜