- 相關(guān)推薦
PHP文件注釋標記及規(guī)范小結(jié)
PHP是在自由開放的環(huán)境中誕生和成長的一門語言。以下是小編整理的PHP文件注釋標記及規(guī)范小結(jié)，希望對大家有所幫助！
PHP 注釋標記
@access
使用范圍：class,function,var,define,module
該標記用于指明關(guān)鍵字的存取權(quán)限：private、public或proteced
@author
指明作者
@copyright
使用范圍：class，function，var，define，module，use
指明版權(quán)信息
@deprecated
使用范圍：class，function，var，define，module，constent，global，include
指明不用或者廢棄的關(guān)鍵字
@example
該標記用于解析一段文件內(nèi)容，并將他們高亮顯示。Phpdoc會試圖從該標記給的文件路徑中讀取文件內(nèi)容
@const
使用范圍：define
用來指明php中define的常量
@final
使用范圍：class,function,var
指明關(guān)鍵字是一個最終的類、方法、屬性，禁止派生、修改。
@filesource
和example類似，只不過該標記將直接讀取當前解析的php文件的內(nèi)容并顯示。
@global
指明在此函數(shù)中引用的全局變量
@ingore
用于在文檔中忽略指定的關(guān)鍵字
@license
相當于html標簽中的<a>,首先是URL，接著是要顯示的內(nèi)容
例如<a href=”http://www.baidu.com”>百度</a>
可以寫作 @license http://www.baidu.com 百度
@link
類似于license
但還可以通過link指到文檔中的任何一個關(guān)鍵字
@name
為關(guān)鍵字指定一個別名。
@package
使用范圍：頁面級別的-> define，function，include
類級別的->class，var，methods
用于邏輯上將一個或幾個關(guān)鍵字分到一組。
@abstrcut
說明當前類是一個抽象類
@param
指明一個函數(shù)的參數(shù)
@return
指明一個方法或函數(shù)的返回指
@static
指明關(guān)建字是靜態(tài)的。
@var
指明變量類型
@version
指明版本信息
@todo
指明應(yīng)該改進或沒有實現(xiàn)的地方
@throws
指明此函數(shù)可能拋出的錯誤異常,極其發(fā)生的情況
普通的文檔標記標記必須在每行的開頭以@標記，除此之外，還有一種標記叫做inline tag,用{@}表示，具體包括以下幾種：
{@link}
用法同@link
{@source}
顯示一段函數(shù)或方法的內(nèi)容
注釋規(guī)范
a.注釋必須是
/**
* 注釋內(nèi)容
*/
的形式
b.對于引用了全局變量的函數(shù)，必須使用glboal標記。
c.對于變量，必須用var標記其類型（int,string,bool…）
d.函數(shù)必須通過param和return標記指明其參數(shù)和返回值
e.對于出現(xiàn)兩次或兩次以上的關(guān)鍵字，要通過ingore忽略掉多余的，只保留一個即可
f.調(diào)用了其他函數(shù)或類的地方，要使用link或其他標記鏈接到相應(yīng)的部分，便于文檔的閱讀。
g.必要的地方使用非文檔性注釋，提高代碼易讀性。
h.描述性內(nèi)容盡量簡明扼要，盡可能使用短語而非句子。
i.全局變量，靜態(tài)變量和常量必須用相應(yīng)標記說明</p
【PHP文件注釋標記及規(guī)范小結(jié)】相關(guān)文章：
PHP文件是什么 如何打開PHP文件08-09
php正則去掉php注釋07-30
php是什么文件10-09
如何打開php文件06-12
PHP文件怎么操作09-03
PHP文件如何打開05-06
PHP配置文件詳解php.ini10-19
PHP文件上傳源碼分析10-13
PHP讀取文件的正確方法09-02
php文件操作函數(shù)解釋11-07