人的記憶力會(huì)隨著歲月的流逝而衰退，寫作可以彌補(bǔ)記憶的不足，將曾經(jīng)的人生經(jīng)歷和感悟記錄下來，也便于保存一份美好的回憶。范文怎么寫才能發(fā)揮它最大的作用呢？下面是小編幫大家整理的優(yōu)質(zhì)范文，僅供參考，大家一起來看看吧。
php注釋語句篇一
php是在自由開放的環(huán)境中誕生和成長(zhǎng)的一門語言。以下是小編整理的php文件注釋標(biāo)記及規(guī)范小結(jié)，希望對(duì)大家有所幫助！
@access
使用范圍：class,function,var,define,module
該標(biāo)記用于指明關(guān)鍵字的存取權(quán)限：private、public或proteced
@author
@copyright
使用范圍：class，function，var，define，module，use
@deprecated
使用范圍：class，function，var，define，module，constent，global，include
@example
該標(biāo)記用于解析一段文件內(nèi)容，并將他們高亮顯示。phpdoc會(huì)試圖從該標(biāo)記給的文件路徑中讀取文件內(nèi)容
@const
使用范圍：define
用來指明php中define的常量
@final
使用范圍：class,function,var
指明關(guān)鍵字是一個(gè)最終的類、方法、屬性，禁止派生、修改。
@filesource
和example類似，只不過該標(biāo)記將直接讀取當(dāng)前解析的php文件的內(nèi)容并顯示。
@global
指明在此函數(shù)中引用的全局變量
@ingore
用于在文檔中忽略指定的關(guān)鍵字
@license
相當(dāng)于html標(biāo)簽中的<a>,首先是url，接著是要顯示的內(nèi)容
例如<a >
可以寫作 @license http:// 百度
@link
類似于license
但還可以通過link指到文檔中的.任何一個(gè)關(guān)鍵字
@name
為關(guān)鍵字指定一個(gè)別名。
@package
類級(jí)別的->class，var，methods
用于邏輯上將一個(gè)或幾個(gè)關(guān)鍵字分到一組。
@abstrcut
說明當(dāng)前類是一個(gè)抽象類
@param
指明一個(gè)函數(shù)的參數(shù)
@return
指明一個(gè)方法或函數(shù)的返回指
@static
指明關(guān)建字是靜態(tài)的。
@var
指明變量類型
@version
指明版本信息
@todo
指明應(yīng)該改進(jìn)或沒有實(shí)現(xiàn)的地方
@throws
指明此函數(shù)可能拋出的錯(cuò)誤異常,極其發(fā)生的情況
普通的文檔標(biāo)記標(biāo)記必須在每行的開頭以@標(biāo)記，除此之外，還有一種標(biāo)記叫做inline tag,用{@}表示，具體包括以下幾種：
{@link}
用法同@link
{@source}
顯示一段函數(shù)或方法的內(nèi)容
注釋規(guī)范
a.注釋必須是
/**
* 注釋內(nèi)容
*/
的形式
b.對(duì)于引用了全局變量的函數(shù)，必須使用glboal標(biāo)記。
c.對(duì)于變量，必須用var標(biāo)記其類型（int,string,bool…）
d.函數(shù)必須通過param和return標(biāo)記指明其參數(shù)和返回值
e.對(duì)于出現(xiàn)兩次或兩次以上的關(guān)鍵字，要通過ingore忽略掉多余的，只保留一個(gè)即可
f.調(diào)用了其他函數(shù)或類的地方，要使用link或其他標(biāo)記鏈接到相應(yīng)的部分，便于文檔的閱讀。
g.必要的地方使用非文檔性注釋，提高代碼易讀性。
h.描述性內(nèi)容盡量簡(jiǎn)明扼要，盡可能使用短語而非句子。
i.全局變量，靜態(tài)變量和常量必須用相應(yīng)標(biāo)記說明</p
s("content_relate");
【php文件注釋標(biāo)記及規(guī)范小結(jié)】相關(guān)文章：
php語言基礎(chǔ)及規(guī)范
09-19
php文件是什么 如何打開php文件
08-27
php文件怎么操作
09-07
09-03
php文件操作函數(shù)解釋
09-07
php文件上傳源碼分析
09-04
php代碼如何規(guī)范
09-16
php文件緩存的性能測(cè)試
09-10
php常用的文件操作函數(shù)
09-09
php讀取文件內(nèi)容的方法
09-08
php注釋語句篇一
php是在自由開放的環(huán)境中誕生和成長(zhǎng)的一門語言。以下是小編整理的php文件注釋標(biāo)記及規(guī)范小結(jié)，希望對(duì)大家有所幫助！
@access
使用范圍：class,function,var,define,module
該標(biāo)記用于指明關(guān)鍵字的存取權(quán)限：private、public或proteced
@author
@copyright
使用范圍：class，function，var，define，module，use
@deprecated
使用范圍：class，function，var，define，module，constent，global，include
@example
該標(biāo)記用于解析一段文件內(nèi)容，并將他們高亮顯示。phpdoc會(huì)試圖從該標(biāo)記給的文件路徑中讀取文件內(nèi)容
@const
使用范圍：define
用來指明php中define的常量
@final
使用范圍：class,function,var
指明關(guān)鍵字是一個(gè)最終的類、方法、屬性，禁止派生、修改。
@filesource
和example類似，只不過該標(biāo)記將直接讀取當(dāng)前解析的php文件的內(nèi)容并顯示。
@global
指明在此函數(shù)中引用的全局變量
@ingore
用于在文檔中忽略指定的關(guān)鍵字
@license
相當(dāng)于html標(biāo)簽中的<a>,首先是url，接著是要顯示的內(nèi)容
例如<a >
可以寫作 @license http:// 百度
@link
類似于license
但還可以通過link指到文檔中的.任何一個(gè)關(guān)鍵字
@name
為關(guān)鍵字指定一個(gè)別名。
@package
類級(jí)別的->class，var，methods
用于邏輯上將一個(gè)或幾個(gè)關(guān)鍵字分到一組。
@abstrcut
說明當(dāng)前類是一個(gè)抽象類
@param
指明一個(gè)函數(shù)的參數(shù)
@return
指明一個(gè)方法或函數(shù)的返回指
@static
指明關(guān)建字是靜態(tài)的。
@var
指明變量類型
@version
指明版本信息
@todo
指明應(yīng)該改進(jìn)或沒有實(shí)現(xiàn)的地方
@throws
指明此函數(shù)可能拋出的錯(cuò)誤異常,極其發(fā)生的情況
普通的文檔標(biāo)記標(biāo)記必須在每行的開頭以@標(biāo)記，除此之外，還有一種標(biāo)記叫做inline tag,用{@}表示，具體包括以下幾種：
{@link}
用法同@link
{@source}
顯示一段函數(shù)或方法的內(nèi)容
注釋規(guī)范
a.注釋必須是
/**
* 注釋內(nèi)容
*/
的形式
b.對(duì)于引用了全局變量的函數(shù)，必須使用glboal標(biāo)記。
c.對(duì)于變量，必須用var標(biāo)記其類型（int,string,bool…）
d.函數(shù)必須通過param和return標(biāo)記指明其參數(shù)和返回值
e.對(duì)于出現(xiàn)兩次或兩次以上的關(guān)鍵字，要通過ingore忽略掉多余的，只保留一個(gè)即可
f.調(diào)用了其他函數(shù)或類的地方，要使用link或其他標(biāo)記鏈接到相應(yīng)的部分，便于文檔的閱讀。
g.必要的地方使用非文檔性注釋，提高代碼易讀性。
h.描述性內(nèi)容盡量簡(jiǎn)明扼要，盡可能使用短語而非句子。
i.全局變量，靜態(tài)變量和常量必須用相應(yīng)標(biāo)記說明</p
s("content_relate");
【php文件注釋標(biāo)記及規(guī)范小結(jié)】相關(guān)文章：
php語言基礎(chǔ)及規(guī)范
09-19
php文件是什么 如何打開php文件
08-27
php文件怎么操作
09-07
09-03
php文件操作函數(shù)解釋
09-07
php文件上傳源碼分析
09-04
php代碼如何規(guī)范
09-16
php文件緩存的性能測(cè)試
09-10
php常用的文件操作函數(shù)
09-09
php讀取文件內(nèi)容的方法
09-08