Java 方法文檔標籤完全指南：@param、@return、@exception、@deprecated

@param：參數說明

@param 參數名 說明文字
// 可跨多行，遇到下一標籤結束

每個參數一個標籤，順序建議與方法簽名一致。

@return：返回值說明

@return 說明文字
// 描述返回值含義、可能值範圍、特殊情況

void 方法可省略或寫 @return 無返回值。

@exception：異常說明

@exception 完整類名 說明文字
// 說明拋出此異常的條件、原因

所有可能拋出的受檢異常皆應記錄。第 9 章詳細講解異常機制。

@deprecated：標記過時

• Java 1.1 新增
• 表示功能已有更好替代，未來版本可能移除
• 使用時編譯器發出警告
• 建議在說明中提供替代方案

文檔註釋位置

緊貼在方法定義之前，格式：/** ... */