PHP入門基礎之注釋的寫法
1 什么是注釋
注釋就是對代碼的解釋和說明,其目的是讓人們能夠更加輕松地了解代碼。注釋是編寫程序時,寫程序的人給一個語句、程序段、函數(shù)等的解釋或提示,能提高程序代碼的可讀性。
1.1 注釋的目的
注釋只是為了提高可讀性,不會被計算機編譯。
1.2 注釋的格式
注釋通常會分為行注釋和塊注釋
- 行注釋: 在符號后那一行不會被編譯
- 塊注釋: 被塊注釋符號中間的部分不會被編譯
2 PHP 的注釋格式
PHP 支持 C,C++ 和 Unix Shell 風格(Perl 風格)的注釋。例如:
<?php echo 'This is a test'; // 這是單行 c++ 樣式注釋 /* 這是一條多行注釋 另一行也是注釋 */ echo 'This is yet another test'; echo 'One Final Test'; # 這是單行 shell 風格的注釋 ?>
2.1 行注釋
單行注釋
C 風格單行注釋
<?php //這是第二行注釋 echo "http://c.biancheng.net/php/"; // echo "PHP 注釋"; ?>
shell 風格單行注釋
#這是第一行注釋 echo "C語言中文網(wǎng)<br>";
注意:單行注釋僅僅注釋到行末或者當前的 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 多行注釋
在需要注釋的代碼塊上以/* 開始,以*/結束。
<?php /* $a = "這是第一行"; $b = "這是第二行"; $c = "這是第三行"; */
注意:C 風格的注釋在碰到第一個 */ 時結束。要確保不要嵌套 C 風格的注釋。
// 錯誤的寫法 // Error: expect statement /* echo 'This is a test'; /* 這個注釋會引發(fā)問題 */ */ ?>
3 小結
合理使用注釋應該滿足以下幾項原則:
- 注釋必須準確、易懂、簡潔,錯誤的注釋不但無益反而有害;
- 注釋可以書寫在代碼中的任意位置,但是一般寫在代碼的開頭或者結束位置;
- 修改程序代碼時,一定要同時修改相關的注釋,以保持代碼和注釋的同步;
- 在實際的代碼規(guī)范中,要求注釋占程序代碼的 20% 左右,即 100 行程序中包含 20 行左右的注釋;
- 避免在注釋中使用縮寫,特別是不常用縮寫;
- 注釋與所描述內容進行同樣的縮進,可使程序排版整齊,并方便注釋的閱讀與理解。
到此這篇關于PHP入門基礎之注釋的寫法的文章就介紹到這了,更多相關PHP注釋內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
php使用curl_init()和curl_multi_init()多線程的速度比較詳解
這篇文章主要介紹了php使用curl_init()和curl_multi_init()多線程的速度比較,結合實例形式詳細分析了curl_init()和curl_multi_init()的具體使用方法及相關效率比較,需要的朋友可以參考下2018-08-08php實現(xiàn)從ftp服務器上下載文件樹到本地電腦的程序
功能:完成從ftp服務器端下載文件到本地電腦(整體復制即目錄樹是一樣的)2009-02-02PHP實現(xiàn)獲取MySQL數(shù)據(jù)庫的記錄數(shù)據(jù)
如果后臺數(shù)據(jù)處理使用PHP來進行,那么就要有相應的數(shù)據(jù)處理及返回。最常用的就是獲取記錄總數(shù)和表記錄查詢結果。本文將為大家介紹如何利用PHP實現(xiàn)獲取MySQL數(shù)據(jù)庫的記錄數(shù)據(jù),需要的可以參考一下2022-02-02PHP數(shù)組相加操作及與array_merge的區(qū)別淺析
這篇文章主要給大家介紹了關于PHP數(shù)組相加操作以及與array_merge的區(qū)別,文中通過示例介紹的很詳細,感興趣的朋友們可以參考學習,有需要的下面跟著小編一起來學習學習吧。2016-11-11