有關PHP文檔產生工具

1. 什麼是phpDocumentor ?

PHPDocumentor是一個用PHP寫的工具，對於有規範註釋的php程序，它能夠快速產生具有相互參照,索引等功能的API文檔。舊的版本是phpdoc，從1.3.0開始，更名為phpDocumentor，新的版本加上了對php5語法的支持，同時，可以透過在客戶端瀏覽器上操作生成文檔，文檔可以轉換為PDF,HTML, CHM幾種形式，非常的方便。

PHPDocumentor工作時，會掃描指定目錄下面的php原始碼，掃描其中的關鍵字，截取需要分析的註釋，然後分析註解中的專用的tag，產生xml文件，接著根據已經分析完的類別和模組的信息，建立相應的索引，生成xml文件，對於生成的xml文件，使用定制的模板輸出為指定格式的文件。

2. 安裝phpDocumentor

和其他pear下的模組一樣，phpDocumentor的安裝也分為自動安裝和手動安裝兩種方式，兩種方式都非常方便：

a．透過pear 自動安裝

在命令列下輸入

pear install PhpDocumentor

b．手動安裝

在http://manual.phpdoc.org/下載最新版本的PhpDocumentor（現在是1.4.2），把內容解壓縮即可。

3．如何使用PhpDocumentor產生文件

a. 命令列方式

在phpDocumentor所在目錄下，輸入

Php -h

會得到一個詳細的參數表，其中幾個重要的參數如下：

分析的檔案名，多個檔案以逗號隔開

-d 要分析的目錄，多個目錄以逗號分割

-t 產生的文檔的存放路徑

-o 輸出的文檔格式，結構為輸出格式：轉換器名稱：模板目錄。

例如：phpdoc -o HTML:frames:earthli -f test.php -t docs

b. Web介面產生

在新的phpdoc中，除了在命令列下產生文件外，還可以在客戶端瀏覽器上操作產生文檔，具體方法是先把PhpDocumentor的內容放在apache目錄下使得透過瀏覽器可以存取到，訪問後顯示如下的介面：

點擊files按鈕，選擇要處理的php文件或資料夾，也可以透過該指定該介面下的Files to ignore來忽略對某些檔案的處理。

然後點選output按鈕來選擇產生文件的存放路徑和格式.

最後點選create，phpdocumentor就會自動開始產生文件了，最下方會顯示產生的進度及狀態，如果成功，會顯示

Total Documentation Time: 1 seconds

done

Operation Completed!!

然後，我們就可以透過查看產生的文檔了，如果是pdf格式的，名字預設為documentation.pdf。

c. 試試phpdocumentor

下面我們就以pear中的phpunit2為例，示範如何使用phpdocumentor來產生文件。

首先，先把我們需要的參數確定下來：

-d

c:/program files/easyphp5/php/pear/phpunit2

-tphp

-o

html:frames:phpedit

根據上邊的參數，我們組合出下邊的命令：

phpdoc -d "c:/program files/eaphp5//pearpear "c:/program files/easyphp5/php/phpunit2doc" -o "html:frames:phpedit"

執行上邊的指令後，phpdocumentor開始解析來源檔案並輸出工作資訊。

命令運行完成後，我們的文件就已經產生好了。進入我們指定的目標目錄，用瀏覽器開啟index.html就可以看見產生的文件了。文件介面由frame分成了三個部分，左上是包信息，左下是導航信息，右邊則是詳細的信息呈現頁。

索引、函數列表、類別列表、檔案列表和子包。點擊上邊的class(es)鏈接，我們可以清楚的看見整個包的class tree。我們點選其中一個class，就進入了class的描述頁。 class描述頁主要包含以下幾個面向內容：

[描述：版權、作者、類別層次等]、[類別變數]、[類別常數]、[方法]、[繼承的變數]、[繼承的方法：非常有用的一個功能]

怎麼樣，是不是很詳細呢？如果要產生chm，可以把前邊的-o參數改為"chm:default: default"，這樣phpdocumentor會為你產生好chm專案文件，只要用微軟的chm工具進行編譯就可以得到可用的chm檔了。

d. 中文亂碼解決方法

如果註解是中文的，需把 PhpDocumentor/phpDocumentor/Converters/* 中對應範本的語言標籤執行 iso-8859-1 到 utf-8 的替換，否則產生出來是亂碼。

4．為php程式碼新增規範的註解

PHPDocument是從你的原始碼的註解中產生文檔，因此在給你的程式做註解的過程，也就是你編製文檔的過程。從這一點上講，PHPdoc促使你要養成良好的程式設計習慣，盡量使用規範，清晰文字為你的程式做註釋，同時多多少少也避免了事後編製文件和文件的更新不同步的一些問題。在phpdocumentor中，註解分為文檔性註解和非文檔性註解。所謂文檔性註釋，是那些放在特定關鍵字前面的多行註釋，特定關鍵字是指能夠被phpdoc分析的關鍵字，例如class，var等，具體的可參加附錄一。那些沒有在關鍵字前面或不規範的註釋就稱為非文檔性註釋，這些註釋將不會被phpdoc分析，也不會出現在你產生的api文當中。

如何書寫文檔性註解:

所有的文檔性註解都是由/**開始的一個多行註釋，在phpDocumentor裡稱為DocBlock,DocBlock是指軟體開發人員編寫的關於某個關鍵字的幫助信息，使得其他人能夠透過它知道這個關鍵字的具體用途，如何使用。 PhpDocumentor規定一個DocBlock包含以下資訊：

1. 功能簡述區

2. 詳細說明區

3. 標記tag

文檔性註釋的第一行是功能描述區，正文一般是簡明扼要地說明這個類，方法或函數的功能，功能簡述的正文在產生的文件中將顯示在索引區。功能描述區的內容可以透過一個空白行或". "來結束。在功能描述區後面是一個空行，接著是詳細說明區，這部分主要是詳細說明你的API的功能、用途、如果可能也可以有用法舉例等等。在這部分，你應該專注於闡明你的API函數或方法的通常的用途、用法，並且指明是否是跨平台的（如果涉及到），對於和平台相關的信息，你要和那些通用的信息區別對待。通常的做法是另起一行，然後寫出在某個特定平台上的注意事項或者是特別的信息，這些信息應該足夠，以便你的讀者能夠編寫相應的測試信息，比如邊界條件，參數範圍，斷點等等。之後同樣是一個空白行，然後是文檔的標記tag，指明一些技術上的信息，主要是調用參數類型、返回值極其類型、繼承關係、相關方法/函數等等。

關於文件標記，詳細的請參考 -- 文檔標記。文件註解中也可以使用例如 這樣的標籤，詳細介紹請參考附錄二。

下面是一個文檔註釋的例子

/**

* 函數add,實現兩個數的加法

*

* 一個簡單的加法計算，函數接受兩個數，b，返回他們的和c

*

* @param int 加數

* @param int 被加數

* @return integer

*/

function Add($a, $b)

{

return $a+$b;

}

產生文件如下：

Add

integer Add( int $a, int $b)

[line 45]

add,實現兩個數的加法，函數接受兩個數a、b，回傳他們的和c

Parameters

? int $a - 加數

? int $b - 被加數

5．文檔標記：

文檔標記的使用範圍是指該標記可以用來修飾的關鍵字，或其他文檔標記。所有的文檔標記都是在每一行的 * 後面以@開頭。如果在一段話的中間出來@的標記，這個標記將會被當做普通內容而被忽略掉。

@access

使用範圍：class,function,var,define,module

此標記用於指明關鍵字的存取權限：private、public或proteced

@author

使用範圍：class，function， var，define，module，use

指明作者

@copyright

使用範圍：class，function，var，define，module，use

指明版權資訊

@deprecated

tion

，define，module，constent，global，include

指明不用或廢棄的關鍵字

@example

該標記用於解析一段文件內容，並將他們高亮顯示。 PHPDOC 會試圖從該標記給的檔案路徑中讀取檔案內容

@const

使用範圍：define

用來指明php中define的常數

@final

使用範圍：class,function,varn,function

指明關鍵字是一個最終的類別、方法、屬性，禁止派生、修改。

@filesource

和example類似，只不過該標記將直接讀取目前解析的php檔案的內容並顯示。

@global

指明在此函數中引用的全域變數

@ingore

用於在文件中忽略指定的關鍵字

@license

相當於html標籤中的 ，接著是要顯示的內容

例如百度

可以寫作@license http://www.baidu.com 百度

@ link

類似於license

但也可以透過link指到文件中的任何一個關鍵字

@name

為關鍵字指定一個別名。

@package

使用範圍：頁面層級的 define，function，include

類別層級的 class，var，methods

用於邏輯上將一個或幾個關鍵字分到一組。

@abstrcut

說明當前類別是一個抽象類別

@param

指明一個函數的參數

@return

指明一個方法或函數的返回指涉的。

@var

指明變數類型

@version

指明版本資訊

@todo

指明應該改進或沒有實現的地方有錯誤的異常所指示的情況

上面提到過，普通的文檔標記標記必須在每行的開頭以@標記，除此之外，還有一種標記叫做inline tag,用{@}表示，具體包括以下幾種：

{@link}

用法同@link

{@source}

顯示一段函數或方法的內容

6．一些註釋規範

a.註釋必須是

/**

* XXXXXXX

*/

的形式

b.對於引用了全局變數的函數，必須使用glboal標記。

c.對於變量，必須用var標記其類型（int,string,bool...）

d.函數必須透過param和return標記指明其參數和傳回值

e.對於出現兩次或兩次以上的關鍵字，要透過ingore忽略掉多餘的，只保留一個即可

f.調用了其他函數或類的地方，要使用link或其他標記鏈接到相應的部分，便於文檔的閱讀。

g.必要的地方使用非文檔性註釋，提高程式碼易讀性。

h.描述性內容盡量簡明扼要，盡可能使用短語而非句子。

i.全域變量，靜態變數和常數必須用對應標記說明

7. 總結

編寫文件是一項乏味卻不得不做的工作，而編寫API級的文檔更是意味著大量的重複勞動和難以維持的一致性。這裡我們要推薦給大家的，是支援php5語法分析的文檔工具--phpDocumentor。 phpDocumentor是一個非常強大的文檔自動生成工具，利用它可以幫助我們編寫規範的註釋，生成易於理解，結構清晰的文檔，對我們的程式碼升級、維護、移交等都有非常大的幫助。使用phpDocumentor不僅可以自動從程式碼中提取出函數和方法定義，還可以自動處理各個class之間的關係，並據此產生class tree。你也可以選擇將文件產生html、chm或pdf。有了phpDocumentor，文件工作變得輕鬆了許多。關於phpDocumentor更詳細的說明，可以到它的官方網站：http://manual.phpdoc.org/ 查閱。