PHP程式標準注釋的規範準則

php作為一門比較容易入門的語言，很多人都是很容易就能夠上手的，但是在你學習的過程中，你也必須要遵守PHP的標準注釋規範。

我們經常編寫一些函數，但是這些函數可能也只有自己能看得懂，甚至過一段時間自己也不認識自己寫的了，那麼怎麼辦呢？最好的辦法當然是給給自己的代碼加上注釋。

我們可能熟悉很多注釋的寫法C pear PHP注釋等等，但我們用到的主要還是# 和/**/。

#是一種簡短的注釋方法。可能你會用它去注釋一個變數，或者調用的一個方法。/**/我們可能還在用它去注釋掉一大段代碼，但是怎麼用它去標準的注釋一個函數呢？

/**
* @name 名字
* @abstract 申明變數/類/方法
* @access 指明這個變數、類、函數/方法的存取許可權
* @author 函數作者的名字和郵箱地址

* @category 組織packages
* @copyright 指明著作權資訊
* @const 指明常量
* @deprecate 指明不推薦或者是廢棄的資訊
* @example 樣本
* @exclude 指明當前的注釋將不進行分析，不出現在文擋中
* @final 指明這是一個最終的類、方法、屬性，禁止派生、修改。
* @global 指明在此函數中引用的全域變數
* @include 指明包含的檔案的資訊
* @link 定義線上串連
* @module 定義歸屬的模組資訊
* @modulegroup 定義歸屬的模組組
* @package 定義歸屬的包的資訊
* @param 定義函數或者方法的參數資訊
* @return 定義函數或者方法的返回資訊
* @see 定義需要參考的函數、變數，並加入相應的超級串連。
* @since 指明該api函數或者方法是從哪個版本開始引入的
* @static 指明變數、類、函數是靜態。
* @throws 指明此函數可能拋出的錯誤異常,極其發生的情況
* @todo 指明應該改進或沒有實現的地方
* @var 定義說明變數/屬性。
* @version 定義版本資訊
*/

注釋的資訊很全面，可能有很多我們用不到，紅色部分是我們經常用到的。

樣本：

檔案頭部模板

/** *這是一個什麼檔案 * *此檔案程式用來做什麼的（詳細說明，可選。）。 * @author      richard<e421083458@163.com> * @version     $Id$ * @since        1.0 */

函數頭部注釋

/** * some_func  * 函數的含義說明 * * @access public * @param mixed $arg1 參數一的說明 * @param mixed $arg2 參數二的說明 * @param mixed $mixed 這是一個混合類型 * @since 1.0 * @return array */  public function thisIsFunction($string, $integer, $mixed) {return array();}

類的注釋

/** * 類的介紹 * * 類的詳細介紹（可選。）。 * @author         richard<e421083458@163.com> * @since          1.0 */  class Test   {  }

程式碼注釋

1. 注釋的原則是將問題解釋清楚，並不是越多越好。

2. 若干語句作為一個邏輯代碼塊，這個塊的注釋可以使用/* */方式。

3. 具體到某一個語句的注釋，可以使用行章節附註釋：//。

/* 組建組態檔案、資料檔案。*/    $this->setConfig();  $this->createConfigFile();  //建立設定檔  $this->clearCache();         // 清除快取檔案  $this->createDataFiles();   // 產生資料檔案  $this->prepareProxys();  $this->restart();