1. 程式人生 > >PHP Document 註釋標記及規範 && PHP命名規範

PHP Document 註釋標記及規範 && 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
該標記用於解析一段檔案內容,並將他們高亮顯示。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.註釋必須是
1
2
3
/**

  • 註釋內容
    */
    的形式
    b.對於引用了全域性變數的函式,必須使用glboal標記。
    c.對於變數,必須用var標記其型別(int,string,bool…)
    d.函式必須通過param和return標記指明其引數和返回值
    e.對於出現兩次或兩次以上的關鍵字,要通過ingore忽略掉多餘的,只保留一個即可
    f.呼叫了其他函式或類的地方,要使用link或其他標記連結到相應的部分,便於文件的閱讀。
    g.必要的地方使用非文件性註釋,提高程式碼易讀性。
    h.描述性內容儘量簡明扼要,儘可能使用短語而非句子。
    i.全域性變數,靜態變數和常量必須用相應標記說明