註釋(Comments)是指在程序編寫過程中,對程序文件或者代碼片段額外添加的一個備註說明。通過註釋可以提高代碼可讀性,讓自己或其他開發人員更快速地理解程序的。
註釋在程序編程中非常重要,恰當的註釋程序不僅是程序員的個人習慣,更是責任的體現。但在實際過程中,大部分程序員都沒有良好的對程序進行註釋習慣,這往往會在日後對自己或他人造成相當大的麻煩。
PHP 註釋不屬於 PHP 程序的一部分,其內容也不參與程序中的任何功能計算,在編輯器中以特殊顏色(如綠色)顯示。
PHP 註釋符號
PHP 支持 C++,C 和 Unix Shell 風格(Perl 風格)的註釋,所以也產生了 3 種PHP註釋符號:
C++ 風格:// 這是 C+ 風格的註釋
C 風格:/* 這是 C 風格的註釋 */
Unix Shell 風格:# 這是 Unix Shell 風格的註釋
一般大家都習慣使用 C 風格與 C++ 風格的註釋。
PHP 註釋格式
PHP 註釋格式分爲單行註釋與多行註釋。
1.PHP 單行註釋
以上三種符號都可用於單行註釋,只是使用 // 或 # 註釋符時,註釋符號後面的文本(本行內)都被視作註釋內容,而 /* */ 風格註釋符必須以 */ 結尾。
例子:
// 這是單行註釋
echo '你好!'; // 這是單行註釋,寫在一行代碼後面也叫行尾註釋
/* 這個註釋風格也不錯 */
# 較少用的風格
?>
上面的行尾註釋,通常只是對本行前面的內容進行註釋,單寫一行的註釋可能是對下面的一行或多行代碼進行註釋,也可能是爲了程序的整體美觀。
2.PHP 多行註釋
多行註釋一般使用 C 風格註釋符,以 /* 開頭,*/ 結尾來包含多行註釋內容:
echo "你好!";
/*
這是多行大塊註釋
這裏面都是註釋內容
更多註釋內容等
*/
?>
注意:不要嵌套使用 C 風格註釋符,因爲在碰到第一個 */ 時系統即認爲該段註釋結束,在註釋掉一大塊代碼時很容易出現該錯誤。如下述用法將產生 PHP 語法錯誤:
echo '你好!';
/*
這是多行大塊註釋
echo '輸出另一些內容'; /* 添加的本行註釋 */
*/
?>
也可以多次使用 // 符號來註釋多行代碼,但一般只限於有限的幾行:
// 分頁顯示定製
// upPage:上一頁
// downPage:下一頁
protected $config = array(
'header' => '條記錄',
'prev' => '上一頁',
'next' => '下一頁',
}
?>
提示:PHP 註釋中不能包含 PHP 代碼結束符即:?>,因爲在任何地方,PHP 檢測到該結束符,即認爲該段 PHP 代碼結束而跳出 PHP 的執行。(編輯:雷林鵬 來源:網絡|侵刪)