PHP文件注釋標記及規(guī)范小結(jié)

本文格式為Word版，下載可任意編輯——PHP文件注釋標記及規(guī)范小結(jié)PHP文件解釋標記及模范小結(jié)

PHP是在自由開放的環(huán)境中誕生和成長的一門語言。以下是我整理的PHP文件解釋標記及模范小結(jié)，夢想對大家有所扶助！

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

該標記用于解析一段文件內(nèi)容，并將他們高亮顯示。Phpdoc會試圖從該標記給的文件路徑中讀取文件內(nèi)容

@const

使用范圍：define

用來指明php中define的常量

@final

使用范圍：class,function,var

指明關鍵字是一個最終的類、方法、屬性，遏止派生、修改。

@filesource

和example類似，只不過該標記將直接讀取當前解析的php文件的內(nèi)容并顯示。

@global

指明在此函數(shù)中引用的全局變量

@ingore

用于在文檔中疏忽指定的`關鍵字

@license

相當于html標簽中的a,首先是URL，接著是要顯示的內(nèi)容

例如ahref='http://.'百度/a

可以寫作@licensehttp://.百度

@link

類似于license

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

@name

為關鍵字指定一個別名。

@package

使用范圍：頁面級別的-define，function，include

類級別的-class，var，methods

用于規(guī)律上將一個或幾個關鍵字分到一組。

@abstrcut

說明當前類是一個抽象類

@param

指明一個函數(shù)的參數(shù)

@return

指明一個方法或函數(shù)的返回指

@static

指明關建字是靜態(tài)的。

@var

指明變量類型

@version

指明版本信息

@todo

指明理應提升或沒有實現(xiàn)的地方

@throws

指明此函數(shù)可能拋出的錯誤奇怪,極其發(fā)生的處境

普遍的文檔標記標記務必在每行的開頭以@標記，除此之外，還有一種標記叫做inlinetag,用@表示，概括包括以下幾種：

@link

用法同@link

@source

顯示一段函數(shù)或方法的內(nèi)容

解釋模范

a.解釋務必是

/**

*解釋內(nèi)容

*/

的形式

b.對于引用了全局變量的函數(shù)，務必使用glboal標記。

c.對于變量，務必用var標記其類型（int,string,bool）

d.函數(shù)務必通過param和return標記指明其參數(shù)和返回值

e.對于展現(xiàn)兩次或兩次以上的關鍵字，要通過ingore疏忽掉多余的，只留存一個即可

f.調(diào)用了其他函數(shù)或類的地方，要使用link或其他標記鏈接到相應的片面，便于文檔的閱讀。