新聞中心

在延平等地區(qū),都構(gòu)建了全面的區(qū)域性戰(zhàn)略布局,加強(qiáng)發(fā)展的系統(tǒng)性、市場前瞻性、產(chǎn)品創(chuàng)新能力,以專注、極致的服務(wù)理念,為客戶提供做網(wǎng)站、成都網(wǎng)站設(shè)計(jì) 網(wǎng)站設(shè)計(jì)制作按需設(shè)計(jì)網(wǎng)站,公司網(wǎng)站建設(shè),企業(yè)網(wǎng)站建設(shè),品牌網(wǎng)站建設(shè),全網(wǎng)營銷推廣,外貿(mào)網(wǎng)站建設(shè),延平網(wǎng)站建設(shè)費(fèi)用合理。
注釋通常在 php 代碼塊中編寫的,它是一個(gè)不可執(zhí)行的部分,不會(huì)顯示在輸出結(jié)果中,在程序運(yùn)行過程中會(huì)被解釋器直接忽略。
規(guī)范的注釋可以讓我們的源代碼更易于理解,同時(shí)也可以幫助我們理解別人或者自己以前編寫的代碼。那么如何進(jìn)行代碼注釋呢?本節(jié)就來給大家介紹一下在 PHP 中進(jìn)行注釋的幾種方式。
在 PHP 中有兩種類型的注釋,分別是單行注釋和多行注釋。
1. 單行注釋
每行必須單獨(dú)使用注釋標(biāo)記,稱為單行注釋。它用于進(jìn)行簡短說明。聲明單行注釋有兩種方式,分別是使用“#”和反斜杠“//”。
示例代碼如下:
";
//這是第二行注釋
echo "http://c.biancheng.net/php/";
// echo "PHP 注釋";
?>
上面的代碼中示例中,第二行使用“#”定義了一條注釋,并分別在第四行和第六行使用“//”定義了一條注釋。
運(yùn)行結(jié)果如下:
C語言中文網(wǎng)
http://c.biancheng.net/php/
提示:單行注釋中使用最廣泛是使用雙斜杠“//”來定義注釋。
2. 多行注釋
多行注釋用于注釋多行內(nèi)容,經(jīng)常用于多行文本的注釋。注釋的內(nèi)容需要包含在(/* 和 */)中,以“/*”開頭,以“*/”結(jié)尾。
提示:多行注釋不能相互嵌套使用。
示例代碼如下:
";
echo "http://c.biancheng.net/php/";
/* echo "PHP 注釋"; */
?>
運(yùn)行結(jié)果如下:
C語言中文網(wǎng)
http://c.biancheng.net/php/
多行注釋經(jīng)常被開發(fā)人員用來介紹某個(gè)函數(shù)或方法的功能以及參數(shù)。另外需要注意的是,多行注釋是由“/*”和“*/”兩個(gè)標(biāo)記構(gòu)成的,忽略任何一個(gè)都不行。
3. 如何有效使用注釋
注釋是程序開發(fā)過程中的一個(gè)重要環(huán)節(jié),主要用來解釋程序的用途、版權(quán)說明、版本號(hào)、生成日期、作者、內(nèi)容等,有助于對(duì)程序的閱讀理解。
合理使用注釋應(yīng)該滿足以下幾項(xiàng)原則:
- 注釋必須準(zhǔn)確、易懂、簡潔,錯(cuò)誤的注釋不但無益反而有害;
- 注釋可以書寫在代碼中的任意位置,但是一般寫在代碼的開頭或者結(jié)束位置;
- 修改程序代碼時(shí),一定要同時(shí)修改相關(guān)的注釋,以保持代碼和注釋的同步;
- 在實(shí)際的代碼規(guī)范中,要求注釋占程序代碼的 20% 左右,即 100 行程序中包含 20 行左右的注釋;
- 避免在注釋中使用縮寫,特別是不常用縮寫;
- 注釋與所描述內(nèi)容進(jìn)行同樣的縮進(jìn),可使程序排版整齊,并方便注釋的閱讀與理解。
本文名稱:PHP注釋:單行注釋+多行注釋
網(wǎng)站地址:http://fisionsoft.com.cn/article/cdipohh.html


咨詢
建站咨詢
