您现在的位置：程式碼之家 >> 編程語言 > >> 網頁程式設計 >> PHP 程式設計 >> PHP 綜合知識

PHP 文件註解標籤速查表（PHPDoc 相容）

編輯：PHP 綜合知識

標準區塊標籤（@tag）

標籤	適用範圍	說明
@access	class, function, var, define, module	存取權限：private、public、protected
@author	所有	作者資訊
@copyright	class, function, var, define, module, use	版權聲明
@deprecated	class, function, var, define, module, constant, global, include	棄用標記
@example	所有	引用外部範例檔
@const	define	常數說明
@final	class, function, var	禁止繼承/覆寫/修改
@filesource	所有	顯示當前檔案原始碼
@global	function	函數內引用的全域變數
@ignore	所有	文件產生時忽略
@license	所有	授權連結（URL 名稱）
@link	所有	相關連結（可指向文件內元素）
@name	所有	元素別名
@package	page: define, function, include class: class, var, methods	邏輯分組
@abstract	class	抽象類別
@param	function, method	參數：型別名稱描述
@return	function, method	回傳：型別描述
@static	function, var	靜態成員
@var	var, property	變數/屬性型別
@version	所有	版本號
@todo	所有	待辦事項
@throws	function, method	可能拋出的例外與條件

Inline 標籤（{@tag}）

標籤	用途
{@link}	行內連結
{@source}	顯示函數/方法原始碼

最小可行文件區塊範例

<?php
/**
 * 簡短描述
 *
 * 詳細說明...
 *
 * @param string $name 參數說明
 * @return bool 回傳說明
 * @throws InvalidArgumentException 例外條件
 */
function demo(string $name): bool { ... }
?>