PHP 的註解寫法規則

PHP 的註解寫法規則很簡單,與 HTML 的註解寫法規則CSS 的註解寫法規則很類似,PHP 的註解寫法也有分為單行註解與多行註解,單行註解用到的符號是雙斜線(//)而多行註解用到的則是開頭註解符號(/*)以及結尾註解符號(*/),其實很簡單。

在寫 PHP 註解範例之前,要先跟各位 PHP 設計師們溝通一個觀念,就是為什麼要寫 PHP 註解?這個問題常常讓 PHP 初學者搞不清楚,因為減短的程式就算沒有寫註解似乎也不會怎麼樣?的確,寫不寫註解並不影響到整個 PHP 程式的運作,可是如果程式越來越龐大呢?沒有寫註解根本無法維護,如果在剛開始學習 PHP 就沒有養成寫註解的習慣,未來在開發大型程式或與其他工程師協同工作時就會很困擾,所以儘管 PHP 註解只是個基礎,卻是一個所有資深 PHP 工程師都會有的好習慣。

PHP 的註解寫法規則範例一、單行註解
範例輸出結果
這是第一行沒有被註解掉的內容
這是第四行沒有被註解掉的內容
範例一所呈現的是 PHP 單行註解的寫法,我們總共輸出(echo)五行內容,第一行 echo 只是 HTML 的網頁編碼,並非本篇重點,第二行 echo 開始就是字串內容,其中有兩行的最前方有使用 PHP 單行註解符號(//),所以在範例的輸出結果看不到這兩行。

PHP 的註解寫法規則範例二、多行註解
範例輸出結果
這是第一行沒有被註解掉的內容
這是第四行沒有被註解掉的內容
範例所使用的是 PHP 多行註解的寫法,我們想要註解掉同樣的那兩行,只需要在要被註解的第一行的開頭用多行註解符號(/*),接著在要被註解的最後一行用(*/)標註,這樣 /* 與 */ 兩個符號之間的多行內容都可以一次被註解掉。

更多 PHP 基礎資料
分享於 2014-12-17 - 更新於 2017-07-31