您现在的位置：程式碼之家 >> 編程語言 > >> 網頁程式設計 >> 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	所有	授權連結：@license URL 顯示文字
@link	所有	關聯連結，可指向文檔內任意元素
@name	所有	為元素指定別名
@package	頁面級/類級	邏輯分組歸屬
@abstract	class	標記抽象類
@param	function	參數說明：類型名稱描述
@return	function	返回值說明：類型描述
@static	所有	標記靜態成員
@var	var	變數類型聲明
@version	所有	版本號
@todo	所有	待改進/未實現事項
@throws	function	可能拋出的異常類型與條件

內聯標籤

{@link}：行內連結，用法同 @link
{@source}：顯示函數/方法局部源碼

實戰範例

/**
 * 用戶認證服務類
 *
 * @package    App\Services\Auth
 * @author     Zhang San 
 * @copyright  2024 Company Inc.
 * @version    2.1.0
 */
class AuthService {
    /**
     * 使用者登入驗證
     *
     * @param string $email    使用者信箱
     * @param string $password 明文密碼
     * @return array           含 token、user 資訊的關聯陣列
     * @throws \App\Exceptions\AuthException 驗證失敗時拋出
     * @todo     支援雙因子驗證 (2FA)
     */
    public function login($email, $password) {
        // ...
    }
}