PHPDocumentor是一個(gè)用PHP寫的工具，對(duì)于有規(guī)范注釋的php程序，它能夠快速生成具有相互參照,索引等功能的API文檔。老的版本是 phpdoc。

1. 什么是phpDocumentor ?PHPDocumentor是一個(gè)用PHP寫的工具，對(duì)于有規(guī)范注釋的php程序，它能夠快速生成具有相互參照,索引等功能的API文檔。老的版本是 phpdoc，從1.3.0開始，更名為phpDocumentor，新的版本加上了對(duì)php5語(yǔ)法的支持，同時(shí)，可以通過(guò)在客戶端瀏覽器上操作生成文檔，文檔可以轉(zhuǎn)換為PDF,HTML,CHM幾種形式，非常的方便。PHPDocumentor工作時(shí)，會(huì)掃描指定目錄下面的php源代碼，掃描其中的關(guān)鍵字，截取需要分析的注釋，然后分析注釋中的專用的tag，生成 xml文件，接著根據(jù)已經(jīng)分析完的類和模塊的信息，建立相應(yīng)的索引，生成xml文件，對(duì)于生成的xml文件，使用定制的模板輸出為指定格式的文件。2. 安裝phpDocumentor和其他pear下的模塊一樣，phpDocumentor的安裝也分為自動(dòng)安裝和手動(dòng)安裝兩種方式，兩種方式都非常方便：a． 通過(guò)pear 自動(dòng)安裝在命令行下輸入pear install PhpDocumentorb． 手動(dòng)安裝在http://manual.phpdoc.org/下載最新版本的PhpDocumentor（現(xiàn)在是1.4.0），把內(nèi)容解壓即可。3．怎樣使用PhpDocumentor生成文檔命令行方式：在phpDocumentor所在目錄下，輸入Php –h會(huì)得到一個(gè)詳細(xì)的參數(shù)表，其中幾個(gè)重要的參數(shù)如下：-f 要進(jìn)行分析的文件名，多個(gè)文件用逗號(hào)隔開-d 要分析的目錄，多個(gè)目錄用逗號(hào)分割-t 生成的文檔的存放路徑-o 輸出的文檔格式，結(jié)構(gòu)為輸出格式：轉(zhuǎn)換器名：模板目錄。例如：phpdoc -o HTML:frames:earthli -f test.php -t docsWeb界面生成在新的phpdoc中，除了在命令行下生成文檔外，還可以在客戶端瀏覽器上操作生成文檔，具體方法是先把PhpDocumentor的內(nèi)容放在apache目錄下使得通過(guò)瀏覽器可以訪問(wèn)到，訪問(wèn)后顯示如下的界面：點(diǎn)擊files按鈕，選擇要處理的php文件或文件夾，還可以通過(guò)該指定該界面下的Files to ignore來(lái)忽略對(duì)某些文件的處理。然后點(diǎn)擊output按鈕來(lái)選擇生成文檔的存放路徑和格式.最后點(diǎn)擊create，phpdocumentor就會(huì)自動(dòng)開始生成文檔了，最下方會(huì)顯示生成的進(jìn)度及狀態(tài)，如果成功，會(huì)顯示Total Documentation Time: 1 secondsdoneOperation Completed!!然后，我們就可以通過(guò)查看生成的文檔了，如果是pdf格式的，名字默認(rèn)為documentation.pdf。4．給php代碼添加規(guī)范的注釋PHPDocument是從你的源代碼的注釋中生成文檔，因此在給你的程序做注釋的過(guò)程，也就是你編制文檔的過(guò)程。從這一點(diǎn)上講，PHPdoc促使你要養(yǎng)成良好的編程習(xí)慣，盡量使用規(guī)范，清晰文字為你的程序做注釋，同時(shí)多多少少也避免了事后編制文檔和文檔的更新不同步的一些問(wèn)題。在phpdocumentor中，注釋分為文檔性注釋和非文檔性注釋。所謂文檔性注釋，是那些放在特定關(guān)鍵字前面的多行注釋，特定關(guān)鍵字是指能夠被phpdoc分析的關(guān)鍵字，例如class，var等，具體的可參加附錄1.那些沒(méi)有在關(guān)鍵字前面或者不規(guī)范的注釋就稱作非文檔性注釋，這些注釋將不會(huì)被phpdoc所分析，也不會(huì)出現(xiàn)在你產(chǎn)生的api文當(dāng)中。3.2如何書寫文檔性注釋:所有的文檔性注釋都是由/**開始的一個(gè)多行注釋，在phpDocumentor里稱為DocBlock, DocBlock是指軟件開發(fā)人員編寫的關(guān)于某個(gè)關(guān)鍵字的幫助信息，使得其他人能夠通過(guò)它知道這個(gè)關(guān)鍵字的具體用途，如何使用。 PhpDocumentor規(guī)定一個(gè)DocBlock包含如下信息：1. 功能簡(jiǎn)述區(qū)2. 詳細(xì)說(shuō)明區(qū)3. 標(biāo)記tag文檔性注釋的第一行是功能描述區(qū)，正文一般是簡(jiǎn)明扼要地說(shuō)明這個(gè)類，方法或者函數(shù)的功能，功能簡(jiǎn)述的正文在生成的文檔中將顯示在索引區(qū)。功能描述區(qū)的內(nèi)容可以通過(guò)一個(gè)空行或者 . 來(lái)結(jié)束在功能描述區(qū)后是一個(gè)空行，接著是詳細(xì)說(shuō)明區(qū),. 這部分主要是詳細(xì)說(shuō)明你的API的功能，用途，如果可能，也可以有用法舉例等等。在這部分，你應(yīng)該著重闡明你的API函數(shù)或者方法的通常的用途，用法，并且指明是否是跨平臺(tái)的（如果涉及到），對(duì)于和平臺(tái)相關(guān)的信息，你要和那些通用的信息區(qū)別對(duì)待，通常的做法是另起一行，然后寫出在某個(gè)特定平臺(tái)上的注意事項(xiàng)或者是特別的信息，這些信息應(yīng)該足夠，以便你的讀者能夠編寫相應(yīng)的測(cè)試信息，比如邊界條件，參數(shù)范圍，斷點(diǎn)等等。之后同樣是一個(gè)空白行，然后是文檔的標(biāo)記tag，指明一些技術(shù)上的信息，主要是最主要的是調(diào)用參數(shù)類型，返回值極其類型，繼承關(guān)系，相關(guān)方法/函數(shù)等等。關(guān)于文檔標(biāo)記，詳細(xì)的請(qǐng)參考第四節(jié):文檔標(biāo)記。文檔注釋中還可以使用例如<b> <code>這樣的標(biāo)簽，詳細(xì)介紹請(qǐng)參考附錄二。下面是一個(gè)文檔注釋的例子

/*** 函數(shù)add,實(shí)現(xiàn)兩個(gè)數(shù)的加法** 一個(gè)簡(jiǎn)單的加法計(jì)算，函數(shù)接受兩個(gè)數(shù)a、b，返回他們的和c** @param int 加數(shù)* @param int 被加數(shù)* @return integer*/function Add($a, $b) {return $a+$b;}

生成文檔如下：Addinteger Add( int $a, int $b)[line 45]函數(shù)add,實(shí)現(xiàn)兩個(gè)數(shù)的加法Constants 一個(gè)簡(jiǎn)單的加法計(jì)算，函數(shù)接受兩個(gè)數(shù)a、b，返回他們的和cParameters• int $a - 加數(shù)• int $b - 被加數(shù)5．文檔標(biāo)記：文檔標(biāo)記的使用范圍是指該標(biāo)記可以用來(lái)修飾的關(guān)鍵字，或其他文檔標(biāo)記。所有的文檔標(biāo)記都是在每一行的 * 后面以@開頭。如果在一段話的中間出來(lái)@的標(biāo)記，這個(gè)標(biāo)記將會(huì)被當(dāng)做普通內(nèi)容而被忽略掉。@access使用范圍：class,function,var,define,module該標(biāo)記用于指明關(guān)鍵字的存取權(quán)限：private、public或proteced@author指明作者@copyright使用范圍：class，function，var，define，module，use指明版權(quán)信息@deprecated使用范圍：class，function，var，define，module，constent，global，include指明不用或者廢棄的關(guān)鍵字@example該標(biāo)記用于解析一段文件內(nèi)容，并將他們高亮顯示。Phpdoc會(huì)試圖從該標(biāo)記給的文件路徑中讀取文件內(nèi)容@const使用范圍：define用來(lái)指明php中define的常量@final使用范圍：class,function,var指明關(guān)鍵字是一個(gè)最終的類、方法、屬性，禁止派生、修改。@filesource和example類似，只不過(guò)該標(biāo)記將直接讀取當(dāng)前解析的php文件的內(nèi)容并顯示。@global指明在此函數(shù)中引用的全局變量@ingore用于在文檔中忽略指定的關(guān)鍵字@license相當(dāng)于html標(biāo)簽中的<a>,首先是URL，接著是要顯示的內(nèi)容例如<a href=”http://www.baidu.com”>百度</a>可以寫作 @license http://www.baidu.com 百度@link類似于license但還可以通過(guò)link指到文檔中的任何一個(gè)關(guān)鍵字@name為關(guān)鍵字指定一個(gè)別名。@package使用范圍：頁(yè)面級(jí)別的-> define，function，include類級(jí)別的->class，var，methods用于邏輯上將一個(gè)或幾個(gè)關(guān)鍵字分到一組。@abstrcut說(shuō)明當(dāng)前類是一個(gè)抽象類@param指明一個(gè)函數(shù)的參數(shù)@return指明一個(gè)方法或函數(shù)的返回指@static指明關(guān)建字是靜態(tài)的。@var指明變量類型@version指明版本信息@todo指明應(yīng)該改進(jìn)或沒(méi)有實(shí)現(xiàn)的地方@throws指明此函數(shù)可能拋出的錯(cuò)誤異常,極其發(fā)生的情況上面提到過(guò)，普通的文檔標(biāo)記標(biāo)記必須在每行的開頭以@標(biāo)記，除此之外，還有一種標(biāo)記叫做inline tag,用{@}表示，具體包括以下幾種：{@link}用法同@link{@source}顯示一段函數(shù)或方法的內(nèi)容6．一些注釋規(guī)范a.注釋必須是/*** XXXXXXX*/的形式b.對(duì)于引用了全局變量的函數(shù)，必須使用glboal標(biāo)記。c.對(duì)于變量，必須用var標(biāo)記其類型（int,string,bool...）d.函數(shù)必須通過(guò)param和return標(biāo)記指明其參數(shù)和返回值e.對(duì)于出現(xiàn)兩次或兩次以上的關(guān)鍵字，要通過(guò)ingore忽略掉多余的，只保留一個(gè)即可f.調(diào)用了其他函數(shù)或類的地方，要使用link或其他標(biāo)記鏈接到相應(yīng)的部分，便于文檔的閱讀。g.必要的地方使用非文檔性注釋，提高代碼易讀性。h.描述性內(nèi)容盡量簡(jiǎn)明扼要，盡可能使用短語(yǔ)而非句子。i.全局變量，靜態(tài)變量和常量必須用相應(yīng)標(biāo)記說(shuō)明7. 總結(jié)phpDocumentor是一個(gè)非常強(qiáng)大的文檔自動(dòng)生成工具，利用它可以幫助我們編寫規(guī)范的注釋，生成易于理解，結(jié)構(gòu)清晰的文檔，對(duì)我們的代碼升級(jí)，維護(hù),移交等都有非常大的幫助。關(guān)于phpDocumentor更為詳細(xì)的說(shuō)明，可以到它的官方網(wǎng)站http://manual.phpdoc.org/查閱8．附錄附錄1:能夠被phpdoc識(shí)別的關(guān)鍵字：IncludeRequireinclude_oncerequire_oncedefinefunctionglobalclass附錄2文檔中可以使用的標(biāo)簽<b><code><br><kdb><li><pre><ul><samp><var>附錄三：一段含有規(guī)范注釋的php代碼 :

<?php/*** Sample File 2, phpDocumentor Quickstart** This file demonstrates the rich information that can be included in* in-code documentation through DocBlocks and tags.* @author Greg Beaver <cellog@php.net>* @version 1.0* @package sample*/// sample file #1/*** Dummy include value, to demonstrate the parsing power of phpDocumentor*/include_once 'sample3.php';/*** Special global variable declaration DocBlock* @global integer $GLOBALS['_myvar']* @name $_myvar*/$GLOBALS['_myvar'] = 6;/*** Constants*//*** first constant*/define('testing', 6);/*** second constant*/define('anotherconstant', strlen('hello'));/*** A sample function docblock* @global string document the fact that this function uses $_myvar* @staticvar integer $staticvar this is actually what is returned* @param string $param1 name to declare* @param string $param2 value of the name* @return integer*/function firstFunc($param1, $param2 = 'optional') {static $staticvar = 7;global $_myvar;return $staticvar;}/*** The first example class, this is in the same package as the* procedural stuff in the start of the file* @package sample* @subpackage classes*/class myclass {/*** A sample private variable, this can be hidden with the --parseprivate* option* @accessprivate* @var integer|string*/var $firstvar = 6;/*** @link http://www.example.com Example link* @see myclass()* @uses testing, anotherconstant* @var array*/var $secondvar =array( 'stuff' => array( 6, 17, 'armadillo' ), testing => anotherconstant);/*** Constructor sets up {@link $firstvar}*/function myclass() {$this->firstvar = 7;}/*** Return a thingie based on $paramie* @param boolean $paramie* @return integer|babyclass*/function parentfunc($paramie) {if ($paramie) {return 6;} else {return new babyclass;}}}/*** @package sample1*/class babyclass extends myclass {/*** The answer to Life, the Universe and Everything* @var integer*/var $secondvar = 42;/*** Configuration values* @var array*/var $thirdvar;/*** Calls parent constructor, then increments {@link $firstvar}*/function babyclass() {parent::myclass();$this->firstvar++;}/*** This always returns a myclass* @param ignored $paramie* @return myclass*/function parentfunc($paramie) {return new myclass;}}?>