| 語法 | 類型 | 範例 |
|---|---|---|
// ... | 單行(C++ 風格) | // 作者:張三 |
# ... | 單行(Shell 風格) | # 日期:2024-01-01 |
/* ... */ | 多行(C 風格) | /* 多行說明\n 可跨多行 */ |
<?php
// 單行註釋:說明下一行用途
$name = 'PHP';
// 多行註釋:函式/類別說明
/*
* 計算兩數總和
* @param int $a
* @param int $b
* @return int
*/
function sum($a, $b) {
return $a + $b;
}
// Shell 風格單行(較少見,但合法)
# 這也是單行註釋
echo sum(1, 2);
用於自動生成 API 文檔、IDE 智慧提示、靜態分析工具(PHPStan/Psalm)型別推斷。
/**
* 使用者服務類別
*
* @package App\Service
* @author 張三 <zhangsan@example.com>
* @version 1.0
*/
class UserService {
/**
* 依 ID 取得使用者
*
* @param int $id 使用者 ID
* @return User|null 使用者實體或 null
* @throws \Exception 找不到時拋出
*/
public function getById(int $id): ?User {
// ...
}
}
@param 參數說明(型別 變數名 說明)@return 回傳值說明@throws 可能拋出的異常@var 屬性/變數型別@method 魔術方法提示@property 動態屬性提示@deprecated 標記棄用@see 參考連結