1 什么是注釋

注釋就是對代碼的解釋和說明，其目的是讓人們能夠更加輕松地了解代碼。注釋是編寫程序時，寫程序的人給一個語句、程序段、函數(shù)等的解釋或提示，能提高程序代碼的可讀性。

1.1 注釋的目的

注釋只是為了提高可讀性，不會被計算機(jī)編譯。

1.2 注釋的格式

注釋通常會分為行注釋和塊注釋

• 行注釋: 在符號后那一行不會被編譯
• 塊注釋: 被塊注釋符號中間的部分不會被編譯

2 PHP 的注釋格式

PHP 支持 C，C++ 和 Unix Shell 風(fēng)格（Perl 風(fēng)格）的注釋。例如:

<?php
    echo 'This is a test'; // 這是單行 c++ 樣式注釋
    /* 這是一條多行注釋
       另一行也是注釋 */
    echo 'This is yet another test';
    echo 'One Final Test'; # 這是單行 shell 風(fēng)格的注釋
?>

2.1 行注釋

單行注釋

C 風(fēng)格單行注釋

<?php
    //這是第二行注釋
    echo "http://c.biancheng.net/php/";
    // echo "PHP 注釋";
?>

shell 風(fēng)格單行注釋

   #這是第一行注釋
    echo "C語言中文網(wǎng)<br>";

注意：單行注釋僅僅注釋到行末或者當(dāng)前的 PHP 代碼塊，視乎哪個首先出現(xiàn)。這意味著在 // … ?> 或者 # … ?> 之后的 HTML 代碼將被顯示出來：?> 跳出了 PHP 模式并返回了 HTML 模式，// 或 # 并不能影響到這一點。

<h1>This is an <?php # echo 'simple';?> example</h1>
<p>The header above will say 'This is an example'.</p>

2.2 多行注釋

在需要注釋的代碼塊上以/* 開始，以*/結(jié)束。

<?php
	/*
	    $a = "這是第一行";
	    $b = "這是第二行";
	    $c = "這是第三行";
	*/

注意：C 風(fēng)格的注釋在碰到第一個 */ 時結(jié)束。要確保不要嵌套 C 風(fēng)格的注釋。

// 錯誤的寫法
// Error: expect statement
/*
   echo 'This is a test'; /* 這個注釋會引發(fā)問題 */
*/
?>

3 小結(jié)

合理使用注釋應(yīng)該滿足以下幾項原則：

• 注釋必須準(zhǔn)確、易懂、簡潔，錯誤的注釋不但無益反而有害；
• 注釋可以書寫在代碼中的任意位置，但是一般寫在代碼的開頭或者結(jié)束位置；
• 修改程序代碼時，一定要同時修改相關(guān)的注釋，以保持代碼和注釋的同步；
• 在實際的代碼規(guī)范中，要求注釋占程序代碼的 20% 左右，即 100 行程序中包含 20 行左右的注釋；
• 避免在注釋中使用縮寫，特別是不常用縮寫；
• 注釋與所描述內(nèi)容進(jìn)行同樣的縮進(jìn)，可使程序排版整齊，并方便注釋的閱讀與理解。

到此這篇關(guān)于PHP入門基礎(chǔ)之注釋的寫法的文章就介紹到這了,更多相關(guān)PHP注釋內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論