在做網(wǎng)站中，不寫(xiě)不必要的注釋?zhuān)挥挟?dāng)代碼不能很好地說(shuō)明邏輯時(shí)，才用注釋補(bǔ)充；把注釋看成程序的一部分，在編寫(xiě)/維護(hù)代碼時(shí)同時(shí)編寫(xiě)/維護(hù)注釋?zhuān)蛔⑨屚耆捎肞HPDocumentor的規(guī)范，以方便用其生成API級(jí)文檔。下面給出各個(gè)部分的注釋示范。

1. 文件頭注釋注釋包括以下方面。

（1）項(xiàng)目、模塊名稱(chēng)，文件名稱(chēng)、功能說(shuō)明。

（2）模塊或文件的使用說(shuō)明。

（3）作者、日期。

（4）修改記錄。

示范：

<?php/***************************************** 項(xiàng)目名稱(chēng)：ZMedia 數(shù)據(jù)抓取服務(wù)* 文件名稱(chēng)：ZMedia-Spider.php* 文件功能：服務(wù)運(yùn)行入口****************************************** 運(yùn)行方式：php ./ZMedia-Spider.php [-s] [控制信號(hào)] [-d]* 參數(shù)說(shuō)明：* -s 控制信號(hào)：start（開(kāi)始運(yùn)行）、stop（結(jié)束運(yùn)行）、restart（重新啟動(dòng)）* -d 調(diào)試狀態(tài)，終端窗口顯示輸出調(diào)試信號(hào)，否則無(wú)窗口運(yùn)行輸出到日志** 如：php ./ZMedia-Spider.php -s restart -d debug******************************************* 創(chuàng)建日期：2015-05-01* 創(chuàng)建作者：張三****************************************** 修改記錄：* 2015-05-01，V1.0，創(chuàng)建文件****************************************/

2. 類(lèi)注釋

注釋包括以下方面。

（1）類(lèi)名稱(chēng)。

（2）作者、日期。

（3）修改記錄。

示范：

<?php/****************************************** 文件功能：日志記錄類(lèi)****************************************** 創(chuàng)建日期：2015-05-21* 創(chuàng)建作者：張三****************************************** 修改記錄：* 2015-05-21，V1.0，創(chuàng)建文件****************************************/

3. 函數(shù)/類(lèi)方法注釋

注釋包括以下方面。

（1）函數(shù)/類(lèi)方法的功能說(shuō)明。

（2）輸入?yún)?shù)說(shuō)明。

（3）輸出結(jié)果說(shuō)明。

（4）（可選）實(shí)現(xiàn)流程說(shuō)明。

示范：/************************************************************ 功能：PHP截取UTF-8字符串，解決半字符問(wèn)題。* 說(shuō)明：英文、數(shù)字（半角）為1字節(jié)（8位），中文（全角）為3字節(jié)************************************************************* 輸入：$str 源字符串* $len 左邊的子串的長(zhǎng)度* 輸出：取出的字符串，當(dāng)$len小于等于0時(shí)，會(huì)返回整個(gè)字符串************************************************************/function utf-substr($str, $len)