PHP 注釋規范


注釋在寫代碼的過程中非常重要,好的注釋能讓你的代碼讀起來更輕松,在寫代碼的時候一定要注意注釋的規范。

php里面常見的幾種注釋方式:

1.文件頭的注釋,介紹文件名,功能以及作者版本號等信息

復制代碼
/** *文件名簡單介紹 * *文件功能。 * @author alvin 作者 * @version 1.0 版本號 */ 
復制代碼

2.函數的注釋,函數作用,參數介紹及返回類型

復制代碼
/** * 函數的含義說明 * * @access public * @param mixed $arg1 參數一的說明 * @param mixed $arg2 參數二的說明 * @param mixed $mixed 這是一個混合類型 * @return array 返回類型 */ 
復制代碼

3.類的注釋,類名及介紹

復制代碼
/** * 類的介紹 * * 類的詳細介紹(可選。)。 * @author alvin 作者 * @version 1.0 版本號 */ 
復制代碼

4.多行注釋

/* php注釋語法 這是多行注釋。*/ 

5.單行注釋

$n = 10; //數量n,這是單行注釋


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM