PHP8 的程式碼註解寫法與 PHP7 相同，主要有兩種形式：
單行註解
使用 // 開頭，之後的文字都視為註解，不可以換行。通常用來對單一行程式碼進行註釋。
// 這是一行註解
$x = 10; // 這個變數儲存了數字 10
多行註解
使用 /* 開頭，*/ 結尾。可以用來註解多行程式碼。
/*
這是一個多行註解
可以用來註解多行程式碼
*/
$y = 20; // 這個變數儲存了數字 20
function myFunction() {
// 這個函式會做一些事情
}
此外，PHP 還支援 PHPDoc 註解，這是一種格式化的註解，可以用來生成程式碼文檔。PHPDoc 註解使用特殊標籤來描述程式碼的功能、參數和返回值。
/**
* 這個函式會將兩個數字相加
*
* @param int $a 第一個數字
* @param int $b 第二個數字
* @return int 兩者相加的結果
*/
function add($a, $b) {
return $a + $b;
}
在 PHP8 中，PHPDoc 註解新增了以下功能：
- 支援匿名參數
- 支援聯合類型
- 支援可變參數
- 支援可選參數
/**
* 這個函式會將兩個數字相加
*
* @param int|float $a 第一個數字
* @param int|float $b 第二個數字
* @return int|float 兩者相加的結果
*/
function add($a, $b) {
return $a + $b;
}
以下是一些撰寫 PHP 程式碼註解的最佳實踐：
- 使用有意義的註解來解釋程式碼的功能。
- 使用 PHPDoc 註解來生成程式碼文檔。
- 保持註解的一致性。
- 避免在註解中包含不必要的資訊。
PHP 8 的程式碼註解在實務上非常好用，尤其是當程式碼數量龐大時，必須透過這些註解讓自己非常清楚每個程式段落是什麼意思，要執行什麼功能，如果是協同工作，更需要程式碼讓團隊合作，善用註解是高級工程師的基本能力。
延伸閱讀