php常見文件注釋說明

2022-07-30 03:39:12 字數 1281 閱讀 2238

@access

使用範圍:class,function,var,define,module

該標記用於指明關鍵字的訪問許可權:private、public或proteced

@author

指明作者

使用範圍: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標籤中的,首先是url,接著是要顯示的內容

@link

類似於license

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

@name

為關鍵字指定乙個別名。

@package

使用範圍:頁面級別的-> define,function,include

類級別的->class,var,methods

用於邏輯上將乙個或幾個關鍵字分到一組。

@abstract

說明當前類是乙個抽象類

@param

指明乙個函式的引數

@return

指明乙個方法或函式的返回指

@static

指明關建字是靜態的。

@var

指明變數型別

@version

指明版本資訊

@todo

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

@throws

指明此函式可能丟擲的錯誤異常,極其發生的情況

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

用法同@link

C 注釋與XML文件說明

c 使用傳統的c風格的注釋方式,即 除了c風格的注釋外,c 還可以根據特定的注釋自動建立xml格式的文件說明。這些注釋都是單行注釋,但都以3個斜槓 開頭,而不是通常的兩個斜槓。在這些注釋中,可以把包含型別和型別成員的文件說明的xml識別符號放在 中。編譯器可以識別的識別符號如下 識別符號 說明 把行...

MVC WebApi 文件生成注釋說明的方法

首先要配置專案可以生成xml說明文件.右擊你的專案 生成 輸出 勾上 xml文件檔案 然後把這個檔名放在下面的 裡.在你的方法上加上說明文件例如 獲取使用者資訊,這個就會顯示在說明文件裡面 get api account userinfo hostauthentication defaultauth...

PHP中常見注釋含義

注釋含義 api 提供給第三方使用的介面 author 標明作者 param 引數 return 返回值 todo 待辦 version 版本號 inheritdoc 文件繼承 property 類屬性 property read 唯讀屬性 property write 只寫屬性 const 常量 ...