| 標籤 | 適用範圍 | 說明 |
@access | class, function, var, define, module | 存取權限:public/protected/private |
@author | 所有 | 作者名稱 Author Name <email@example.com> |
@copyright | class, function, var, define, module, use | 版權聲明 |
@deprecated | class, function, var, define, module, constant, global, include | 標記棄用,建議替代方案 |
@example | 所有 | 範例檔案路徑,文檔生成器會高亮顯示內容 |
@const | define | 說明常數 |
@final | class, function, var | 禁止繼承/覆寫/修改 |
@filesource | file | 顯示當前檔案完整原始碼 |
@global | function | 函數內使用的全域變數 @global type $varname |
@ignore | 所有 | 文檔生成時忽略此元素 |
@license | 所有 | 授權連結 @license URL 名稱 |
@link | 所有 | 相關連結,可連到文檔內其他元素 |
@name | 所有 | 元素別名 |
@package | file: define,function,include / class: class,var,method | 邏輯分組(如 @package MyProject\Component) |
@abstract | class | 標記抽象類別 |
@param | function, method | 參數 @param type $name 說明 |
@return | function, method | 返回值 @return type 說明 |
@static | function, method, var | 標記靜態成員 |
@var | var, property | 變數/屬性型別 @var Type 說明 |
@version | 所有 | 版本號 @version 1.0.0 |
@todo | 所有 | 待辦事項 |
@throws | function, method | 拋出異常 @throws ExceptionClass 條件 |