我們經(jīng)常編寫(xiě)一些函數(shù)，但是這些函數(shù)可能也只有自己能看得懂，甚至過(guò)一段時(shí)間自己也不認(rèn)識(shí)自己寫(xiě)的了，那么怎么辦呢？最好的辦法當(dāng)然是給給自己的代碼加上注釋。

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

#是一種簡(jiǎn)短的注釋方法?？赡苣銜?huì)用它去注釋一個(gè)變量，或者調(diào)用的一個(gè)方法。/**/我們可能還在用它去注釋掉一大段代碼，但是怎么用它去標(biāo)準(zhǔn)的注釋一個(gè)函數(shù)呢？

/**
* @name 名字
* @abstract 申明變量/類/方法
* @access 指明這個(gè)變量、類、函數(shù)/方法的存取權(quán)限
* @author 函數(shù)作者的名字和郵箱地址

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

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

示例：

文件頭部模板

/** *這是一個(gè)什么文件 *此文件程序用來(lái)做什么的（詳細(xì)說(shuō)明，可選。）。 * @author richard e421083458@163.com * @version $Id$ * @since 1.0 */

函數(shù)頭部注釋

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

類的注釋

/** * 類的介紹 * 類的詳細(xì)介紹（可選。）。 * @author richard e421083458@163.com * @since 1.0 class Test }

程序代碼注釋

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

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

3. 具體到某一個(gè)語(yǔ)句的注釋，可以使用行尾注釋：//。

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

相關(guān)推薦：

PHP 中的注釋，PHP注釋

以上就是PHP程序標(biāo)準(zhǔn)注釋的規(guī)范準(zhǔn)則的詳細(xì)內(nèi)容，PHP教程

鄭重聲明：本文版權(quán)歸原作者所有，轉(zhuǎn)載文章僅為傳播更多信息之目的，如作者信息標(biāo)記有誤，請(qǐng)第一時(shí)間聯(lián)系我們修改或刪除，多謝。