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

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

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

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

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

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

示例：

文件頭部模板

/** *這是一個什么文件 *此文件程序用來做什么的（詳細說明，可選。）。 * @author richard [email protected] * @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 [email protected] * @since 1.0 class Test }

程序代碼注釋

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

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

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

/* 生成配置文件、數據文件。*/ $this- setConfig(); $this- createConfigFile(); //創建配置文件 $this- clearCache(); // 清除緩存文件 $this- createDataFiles(); // 生成數據文件 $this- prepareProxys(); $this- restart();

相關推薦：

PHP 中的注釋，PHP注釋

以上就是PHP程序標準注釋的規范準則的詳細內容，PHP教程

鄭重聲明：本文版權歸原作者所有，轉載文章僅為傳播更多信息之目的，如作者信息標記有誤，請第一時間聯系我們修改或刪除，多謝。