寫(xiě)在前面

注釋可以理解成代碼中的解釋和說(shuō)明。使用注釋不僅能提高程序的可讀性，而且有利于程序的后期維護(hù)工作，注釋內(nèi)容不會(huì)被程序所執(zhí)行。

個(gè)人項(xiàng)目

個(gè)人站點(diǎn)：<a >LN電影網(wǎng)</a>
個(gè)人博客：<a >L&N博客</a>

PHP 的注釋

PHP 注釋有 3 中風(fēng)格

1. C++ 風(fēng)格的單行注釋 （//）

// 這是一條注釋信息：打印 hello world
echo 'hello world';

2. C++ 風(fēng)格的多行注釋 （/**/）

 /* 這是一個(gè)多行注釋
       echo '你好';
       echo ‘這個(gè)世界’;
    */

echo "你好這個(gè)世界";

3. 使用 Shell 風(fēng)格的注釋（#）

跟 單行注釋類似，# 所在行不會(huì)被執(zhí)行

echo '你好這個(gè)世界'; # shell 風(fēng)格注釋，這里的內(nèi)容不會(huì)被執(zhí)行

PHP 的有效注釋

程序注釋是書(shū)寫(xiě)規(guī)范程序是很重要的環(huán)節(jié)。注釋主要是針對(duì)代碼的解釋與說(shuō)明，主要作用如下：解釋腳本用途、版權(quán)說(shuō)明、版本號(hào)、生成日期、作者、內(nèi)容等等。有助于對(duì)程序的閱讀理解

注釋原則

語(yǔ)言

• 注釋語(yǔ)言必須準(zhǔn)確、易懂、簡(jiǎn)潔

說(shuō)明： 錯(cuò)誤的注釋不但無(wú)益反而有害

• 注釋在編譯代碼時(shí)會(huì)被忽略，不會(huì)被編譯器編譯到最后的可執(zhí)行文件中，所以注釋不會(huì)增加執(zhí)行文件大小。

• 注釋可以書(shū)寫(xiě)在代碼中的任意位置，但是一般寫(xiě)在代碼的開(kāi)頭或者結(jié)束位置

說(shuō)明：避免在一行代碼或者表達(dá)式中間插入注釋。否則容易產(chǎn)生理解偏差

• 修改程序代碼時(shí)，一定要同時(shí)修改相關(guān)的注釋，保證代碼和注釋的同步

• 在實(shí)際代碼規(guī)范中，要求注釋代碼占程序代碼的比例達(dá)到 20% 左右，即 100 行代碼有 20 行注釋

說(shuō)明: 防止不必要的注釋

• 在程序塊的結(jié)束行右方添加注釋，以表明某段程序快結(jié)束

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

• 注釋與所描述內(nèi)容同樣的縮寫(xiě)，可以使程序排版整齊，并且方便注釋的閱讀與理解

總結(jié)

如果想成為一名嚴(yán)謹(jǐn)、有態(tài)度的程序員，這些看似無(wú)關(guān)緊要的原則其實(shí)代表了我們對(duì)所編寫(xiě)程序的一種負(fù)責(zé)態(tài)度。