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

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

PHP是在自由開(kāi)放的環(huán)境中誕生和成長(zhǎng)的一門(mén)語(yǔ)言。以下是我整理的PHP文件解釋標(biāo)記及模范小結(jié)，夢(mèng)想對(duì)大家有所扶助！

PHP解釋標(biāo)記

@access

使用范圍：class,function,var,define,module

該標(biāo)記用于指明關(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

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

@const

使用范圍：define

用來(lái)指明php中define的常量

@final

使用范圍：class,function,var

指明關(guān)鍵字是一個(gè)最終的類(lèi)、方法、屬性，遏止派生、修改。

@filesource

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

@global

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

@ingore

用于在文檔中疏忽指定的`關(guān)鍵字

@license

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

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

可以寫(xiě)作@licensehttp://.百度

@link

類(lèi)似于license

但還可以通過(guò)link指到文檔中的任何一個(gè)關(guān)鍵字

@name

為關(guān)鍵字指定一個(gè)別名。

@package

使用范圍：頁(yè)面級(jí)別的-define，function，include

類(lèi)級(jí)別的-class，var，methods

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

@abstrcut

說(shuō)明當(dāng)前類(lèi)是一個(gè)抽象類(lèi)

@param

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

@return

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

@static

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

@var

指明變量類(lèi)型

@version

指明版本信息

@todo

指明理應(yīng)提升或沒(méi)有實(shí)現(xiàn)的地方

@throws

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

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

@link

用法同@link

@source

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

解釋模范

a.解釋務(wù)必是

/**

*解釋內(nèi)容

*/

的形式

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

c.對(duì)于變量，務(wù)必用var標(biāo)記其類(lèi)型（int,string,bool）

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

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

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