PHP 代碼注釋

寫在前面

注釋可以理解成代碼中的解釋和說明。使用注釋不僅能提高程式的可讀性，而且有利於程式的後期維護工作，注釋內容不會被程式所執行。

個人項目

個人網站：LN電影網個人部落格：L&N部落格

PHP 的注釋

PHP 注釋有 3 中風格

1. C++ 風格的單行注釋 （//）

// 這是一條注釋資訊：列印 hello worldecho 'hello world';

2. C++ 風格的多行注釋 （/**/）

 /* 這是一個多行注釋       echo '你好';       echo ‘這個世界’;    */echo "你好這個世界";

3. 使用 Shell 風格的注釋（#）

跟 單行注釋類似，# 所在行不會被執行

echo '你好這個世界'; # shell 風格注釋，這裡的內容不會被執行

PHP 的有效注釋

程式注釋是書寫規範程式是很重要的環節。注釋主要是針對代碼的解釋與說明，主要作用如下：解釋指令碼用途、著作權說明、版本號碼、產生日期、作者、內容等等。有助於對程式的閱讀理解

注釋原則

語言

• 注釋語言必須準確、易懂、簡潔

說明： 錯誤的注釋不但無益反而有害

• 注釋在編譯代碼時會被忽略，不會被編譯器編譯到最後的可執行檔中，所以注釋不會增加執行檔案大小。

• 注釋可以書寫在代碼中的任意位置，但是一般寫在代碼的開頭或者結束位置

說明：避免在一行代碼或者運算式中間插入注釋。否則容易產生理解偏差

• 修改程式碼時，一定要同時修改相關的注釋，保證代碼和注釋的同步

• 在實際代碼規範中，要求注釋代碼占程式碼的比例達到 20% 左右，即 100 行代碼有 20 行注釋

說明: 防止不必要的注釋

• 在程式塊的結束行右方添加註釋，以表明某段程式快結束

• 避免在注釋中使用縮寫，特別是非常用縮寫

• 注釋與所描述內容同樣的縮寫，可以使程式排版整齊，並且方便注釋的閱讀與理解

總結

如果想成為一名嚴謹、有態度的程式員，這些看似無關緊要的原則其實代表了我們對所編寫程式的一種負責態度。

