php定名、注釋規範

php命名、注釋規範

一、注釋

1.檔案頭部模板

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

2.函數頭部注釋

/** * 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();}  

3.類的注釋

/** * 類的介紹 * * 類的詳細介紹（可選。）。 * @author         richard<[email protected]> * @since          1.0 */  class Test   {  }  

4.程式碼注釋

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

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

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

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

二、命名規範

http://alloyteam.github.io/code-guide/#project-naming

