@access 使用范圍:class,function,var,define,module 該標記用于指明關鍵字的存取權限:private、public或proteced

@author 指明作者

@copyright 使用范圍:class,function,var,define,module,use 指明版權 " /> 欧美一级高清片免费一级,国产成人精品在视频,亚洲一区二区三区在线网站

一区二区久久-一区二区三区www-一区二区三区久久-一区二区三区久久精品-麻豆国产一区二区在线观看-麻豆国产视频

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

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
該標記用于解析一段文件內容,并將他們高亮顯示。phpdoc會試圖從該標記給的文件路徑中讀取文件內容

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

@final
使用范圍:class,function,var
指明關鍵字是一個最終的類、方法、屬性,禁止派生、修改。

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

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

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

@license
相當于html標簽中的<a>,首先是URL,接著是要顯示的內容
例如<a href=”http://www.baidu.com”>百度</a>
可以寫作 @license http://www.baidu.com 百度

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

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

@package
使用范圍:頁面級別的-> define,function,include
類級別的->class,var,methods
用于邏輯上將一個或幾個關鍵字分到一組。

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

@param
指明一個函數的參數

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

@static
指明關建字是靜態的。

@var
指明變量類型

@version
指明版本信息

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

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

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

{@link}
用法同@link

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

注釋規范

a.注釋必須是

/**
* 注釋內容
*/

的形式

b.對于引用了全局變量的函數,必須使用glboal標記。

c.對于變量,必須用var標記其類型(int,string,bool…)

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

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

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

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

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

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

php技術PHP文件注釋標記及規范小結,轉載需保留來源!

鄭重聲明:本文版權歸原作者所有,轉載文章僅為傳播更多信息之目的,如作者信息標記有誤,請第一時間聯系我們修改或刪除,多謝。

主站蜘蛛池模板: 国产成人青草视频 | 国产熟睡乱子伦视频 | 欧美性色xo影院永久禁欲 | 一区小说二区另类小说三区图 | 好吊妞操 | 色播亚洲精品网站 亚洲第一 | 2020年国产精品午夜福利在线观看 | 国产精品久久久久久久久ktv | 色婷婷综合久久久中文字幕 | 78m成人亚洲 | 中文字幕在线精品 | 草湿影院 | a男人的天堂久久a毛片 | 日产一一到六区麻豆 | 成人午夜精品 | 婷婷的五月 | 国产综合视频在线观看一区 | 91青青| 色视频免费网站 | 怡红院在线观看精品 | 免费看一区二区三区 | 一个色综合网站 | 日韩精品一区二区三区在线观看 | 色吊网 | 黄色网址在线视频 | 成年网站在线播放 | 国产精品久久九九 | 韩国美女一区二区 | 在线观看色 | 草草草在线观看 | 四川农村女人一级毛片 | 在线观看免费黄色小视频 | 男女爱爱爽爽福利免费视频 | 一本久久a久久精品亚洲 | 精品一区二区三区的国产在线观看 | 国产第一第二第三第四第五 | 国产精品亚洲高清一区二区 | 99成人在线 | 日本不卡一区二区三区四区 | 国产成人免费高清激情视频 | 国产精品外围在线观看 |