轉貼自http://www.yqdown.com/wangluobiancheng/PHP/3429.htm

PHPDocumentor是一個用PHP寫的工具,對於有規範註釋的php程序,它能夠高速 生成具有相互參照,索引等功能的API文檔。老的版本是 phpdoc

  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.3),把內容解壓即可。 

     

  3. 怎樣運用 PhpDocumentor生成文檔
     

    命令行方式:
    phpDocumentor所在目錄下,輸入
    php –h
    會得到一個詳細的參數表,其中多個主要的參數如下:
    -f
    要執行分析的檔案名,多個檔案用逗號隔開
    -d
    要分析的目錄,多個目錄用逗號分割
    -t
    生成的文檔的存放路徑
    -o
    輸出的文檔格式,結構為輸出格式:轉換器名:模板目錄。
    例如:./phpdoc -o HTML:frames:earthli -f test.php -t docs

    Web界面生成:
    在新的phpdoc中,除了在命令行下生成文檔外,還可以在客戶端瀏覽器上操作生成文檔,具體方法是先把PhpDocumentor的內容放在apache目錄下使得通過瀏覽器可以讀取到,讀取後會顯示如下的界面:
    點擊files按鈕,選擇要處理的php文件或文件夾,還可以通過該指定該界面下的Files to ignore來忽略對某些文件的處理。
    然後點擊output按鈕來選擇生成文檔的存放路徑和格式.
    最後點擊createphpdocumentor就會自動開始生成文檔了,最下方會顯示生成的進度及狀態,如果成功,會顯示
    Total Documentation Time: 1 seconds
    done
    Operation Completed!!
    然後,我們就可以通過查看生成的文檔了,如果是pdf格式的,名字預設為documentation.pdf

  4. php代碼添加規範的註釋
    PHPDocument
    是從你原始碼的註釋中生成文檔,因此在在你程式中做註釋的流程 ,也就是你編製文檔的流程 。
    從這一點上講,PHPdoc促使你要養成良好的編程習慣,盡量運用規範,清晰的文字為你的程式做註釋,同時多多少少也防止 了事後編製文檔和文檔的更新不同步的一些問題。

 

phpdocumentor中,註釋分為文檔性註釋和非文檔性註釋。
所謂文檔性註釋,是那些放在特定關鍵字前面的多行註釋,特定關鍵字是指能夠被phpdoc分析的關鍵字,例如classvar等,具體的細節可參考附錄1.
那些沒有在關鍵字前面或者不規範的註釋就稱作非文檔性註釋,這些註釋將不會被phpdoc所分析,也不會出現在你產生的api文當中。

5. 如何 書寫文檔性註釋:
所有的文檔性註釋都是由/**開始的一個多行註釋,在phpDocumentor裡稱為 DocBlock, DocBlock是指軟體開發人員編寫的關於某個關鍵字的幫助訊息,使得 其他人能夠通過它知道這個關鍵字的具體用途,如何運用 。PhpDocumentor規定 一個DocBlock包含如下訊息:
1.
功能簡述區
2.
詳細說明區
3.
標記tag


文檔性註釋的第一行是功能簡述區,正文一般是簡明扼要地說明這個類別,方法或者 函數的功能,功能簡述的正文在生成的文檔中將顯示在索引區。功能描述區的內容可 以通過一個空行或者 . 結束。

在功能描述區後是一個空行,接着是詳細說明區,這部分主要是詳細說明你的API 功能,用途,如果可能,也可以有用法舉例等等。在這部分,你應該着重闡明你的 API函數或者方法的通常用途,用法,並且指明能不能跨平台(如果涉及到),對於 和平台有關的訊息,你要和那些通用的訊息區別對待,通常的做法是另起一行,然後 寫出在某個特定平台上的留心事項或者是特別的訊息,這些訊息應該足夠,以便你的 讀者能夠編寫相對應的測試訊息,比如邊界條件,參數範圍,斷點等等。


之後同樣是一個空白行,然後是文檔的標記tag,指明一些技能上的訊息,主要是最 主要的是調用參數類型,回傳值及其類型,繼承聯系 ,有關方法/函數等等。關於 文檔標記,詳細的請參考第四節:文檔標記。

文檔註釋中還可以運用例如<b> <code>這樣的標籤,詳細介紹請參考附錄二。
下面是一個文檔註釋的例子

 

/**
*
函數add,實現兩個數的加法
*
*
一個基本的加法計算,函數接受兩個數ab,返回他們的和c
*
* @param int
加數
* @param int
被加數
* @return integer
*/
function Add($a, $b) {
return $a+$b;
}

生成文檔如下:
Add
integer Add( int $a, int $b)
[line 45]
函數add,實現兩個數的加法
Constants
一個基本的加法計算,函數接受兩個數ab,返回他們的和c
Parameters
• int $a –
加數
• int $b –
被加數

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

@access
運用範圍:class,function,var,define,module
該標記用於指明關鍵字的存取權限:privatepublicproteced

@author

指明作者

@copyright
運用範圍:classfunctionvardefinemoduleuse
指明版權訊息

@deprecated
運用範圍:classfunctionvardefinemodule

constentglobalinclude

指明廢棄或不用的關鍵字

@example
該標記用於分析 一段文件內容,並將他們高亮顯示。Phpdoc會試圖從該標 記給的文件路徑中讀取文件內容

@const
運用範圍:define
用來指明phpdefine的常數

@final
運用範圍:class,function,var
指明關鍵字是一個最終的類、方法 、屬性,禁止派生、修改。

@filesource
example類似,只不過該標記將直接讀取當前分析 的php文件的內容並 顯示。

 

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

@ingore
用於在文檔中忽略指定的關鍵字

@license
相當於html標籤中的<a>,首先是URL,接着是要顯示的內容
例如<a href=”http://www.baidu.com”>百度</a>
可以寫作 @license http://www.baidu.com 百度

@link
類似於license
但還可以通過link指到文檔中的任何一個關鍵字

@name
為關鍵字指定一個別名。

@package
運用範圍:頁面級別的-> definefunctioninclude
類別級別的->classvarmethods
用於邏輯上將一個或多個關鍵字分到一組。

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

@param
指明一個函數的參數

@return
指明一個方法或函數的回傳值

@static
指明關鍵字是靜態的。

@var
指明變數類型

@version
指明版本訊息

@todo
指明應該改良或沒有實現的地方

 

@throws
指明此函數可能拋出的不正確,異常,其發生的情況


上面提到過,普通的文檔標記標記必須在每行的開頭以@標記,除此之外,還 有一種標記叫做inline tag,{@}表示,具體包括以下幾種:
{@link}
用法同@link
{@source}
顯示一段函數或方法的內容

 

7一些註釋規範
a.
註釋必須是
/**
* XXXXXXX
*/
的形式
b.
對於引用了全域變數的函數,必須運用 glboal標記。
c.
對於變數,必須用var標記其類型(int,string,bool…
d.
函數必須通過paramreturn標記指明其參數和回傳值
e.
對於出現兩次或兩次以上的關鍵字,要通過ingore忽略掉多餘的,只保留一個 即可
f.
調用了其他函數或類別的地方 ,要運用link或其他標記鏈接到相應的部分,便 於文檔的閱讀。
g.
於必要的地方運用非文檔性註釋,提高代碼易讀性。
h.
描述性內容盡量簡明扼要,盡可能運用短語而非句子。
i.
全域變數,靜態變數和常數必須用相應標記說明

7. 總結
phpDocumentor
是一個非常強大的文檔自動生成工具,運用它可以幫助我們編寫規範的註釋,生成易於理解,結構清晰的文檔,對我們的程式碼升級,維護,移交等都有非常大的幫助。關於phpDocumentor更為詳細的說明,可以到它的官方網站 http://manual.phpdoc.org/查閱

8.附錄
附錄1:
能夠被phpdoc識別的關鍵字:
Include
Require
include_once
require_once
define
function
global
class

附錄2
文檔中可以運用的標籤
<b>
<code>
<br>
<kdb>
<li>
<pre>
<ul>
<samp>
<var>

廣告