PHP 註釋語法速查：單行與多行註釋

PHP 註釋語法速查：單行與多行註釋

PHP 支援三種註釋風格，適當使用可提升代碼可讀性與維護性。

單行註釋

// 這是單行註釋
# 這也是單行註釋

多行註釋

/* 這是多行註釋
   可以跨越多行
   結束於 */

文件區塊註釋

常用於 API 文件產生工具（如 phpDocumentor）：

/**
 * 類別簡短說明
 *
 * 詳細描述...
 *
 * @author 作者名
 * @version 1.0
 */

實際範例

<?php
$txt1 = "Learn PHP";
$txt2 = "w3cschool.cc";
$cars = array("Volvo", "BMW", "Toyota");

echo $txt1;
echo "<br>";
echo "Study PHP at $txt2";
echo "My car is a {$cars[0]}";
echo "<br>";
echo "{$txt1}";
?>

最佳實務建議

• 單行說明用 //，避免 #（較少見）。
• 區塊說明用 /* */。
• 公開 API 必須撰寫 PHPDoc 區塊註釋。
• 註釋「為什麼」而非「做什麼」（代碼本身已說明做什麼）。