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();
相關建議：
以上是PHP程式標準註解的規範準則的詳細內容。更多資訊請關注PHP中文網其他相關文章！
