程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> 網頁編程 >> PHP編程 >> 關於PHP編程 >> PHP文件注釋標記及規范小結

PHP文件注釋標記及規范小結

編輯:關於PHP編程

    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標簽中的<a>,首先是URL,接著是要顯示的內容
    例如<a href=”http://www.baidu.com”>百度</a>
    可以寫作 @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.全局變量,靜態變量和常量必須用相應標記說明

    1. 上一頁:
    2. 下一頁:
    Copyright © 程式師世界 All Rights Reserved