熱點推薦:
您现在的位置: 電腦知識網 >> 編程 >> PHP編程 >> 正文

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

2013-11-15 12:30:31  來源: PHP編程 

  PHP 注釋標記

@access
使用范圍classfunctionvardefinemodule
該標記用於指明關鍵字的存取權限privatepublic或proteced

@author
指明作者

@copyright
使用范圍classfunctionvardefinemoduleuse
指明版權信息

@deprecated
使用范圍classfunctionvardefinemoduleconstentglobalinclude
指明不用或者廢棄的關鍵字

@example
該標記用於解析一段文件內容並將他們高亮顯示Phpdoc會試圖從該標記給的文件路徑中讀取文件內容

@const
使用范圍define
用來指明php中define的常量

@final
使用范圍classfunctionvar
指明關鍵字是一個最終的類方法屬性禁止派生修改

@filesource
和example類似只不過該標記將直接讀取當前解析的php文件的內容並顯示

@global
指明在此函數中引用的全局變量

@ingore
用於在文檔中忽略指定的關鍵字

@license
相當於html標簽中的<a>首先是URL接著是要顯示的內容
例如<a href=”百度</a>
可以寫作 @license 百度

@link
類似於license
但還可以通過link指到文檔中的任何一個關鍵字

@name
為關鍵字指定一個別名

@package
使用范圍頁面級別的> definefunctioninclude
類級別的>classvarmethods
用於邏輯上將一個或幾個關鍵字分到一組

@abstrcut
說明當前類是一個抽象類

@param
指明一個函數的參數

@return
指明一個方法或函數的返回指

@static
指明關建字是靜態的

@var
指明變量類型

@version
指明版本信息

@todo
指明應該改進或沒有實現的地方

@throws
指明此函數可能拋出的錯誤異常極其發生的情況

普通的文檔標記標記必須在每行的開頭以@標記除此之外還有一種標記叫做inline tag用{@}表示具體包括以下幾種

{@link}
用法同@link

{@source}
顯示一段函數或方法的內容

注釋規范

a注釋必須是

/**
* 注釋內容
*/

的形式

b對於引用了全局變量的函數必須使用glboal標記

c對於變量必須用var標記其類型(intstringbool…)

d函數必須通過param和return標記指明其參數和返回值

e對於出現兩次或兩次以上的關鍵字要通過ingore忽略掉多余的只保留一個即可

f調用了其他函數或類的地方要使用link或其他標記鏈接到相應的部分便於文檔的閱讀

g必要的地方使用非文檔性注釋提高代碼易讀性

h描述性內容盡量簡明扼要盡可能使用短語而非句子

i全局變量靜態變量和常量必須用相應標記說明


From:http://tw.wingwit.com/Article/program/PHP/201311/21081.html
    推薦文章
    Copyright © 2005-2013 電腦知識網 Computer Knowledge   All rights reserved.