phpdocmentor安裝使用詳解

安裝phpDocumentor

在pear下安裝phpDocumentor是一件極其簡單的事情，只須要在cmd窗口中cd 到php目錄下，而後輸入

Pear install phpDocumentor便可。

若是顯示 Pear 不是內部或外部命令，也不是可運行的程序或批處理文件。則須要先運行 php文件夾裏的 go-pear.bat 文件。直接按回車便可裝好。期間須要輸入一次y，再按任意鍵就能夠了。

而後咱們再進入dos下運行 pear命令

當出現這種錯誤的時候，是由於分配的內存不夠
有如下辦法解決：
1、修改php.ini（推薦）
memory_limit = 128M
2、在程序裏面添加以下語句
ini_set("memory_limit","128M");
3、在根目錄創建.htaccess文件，添加以下內容(注意是這種根目錄D:\wamp\php\PEAR\PEAR)
php_value memory_limit 128M
若是還不能解決，就把它改得再大一些。（介紹一個辦法創建.htaccess文件，新建一個文本文檔，而後在裏面寫好以上語句，另存爲的時候，選擇全部文件，而後文件名爲：.htaccess 便可）
最後注意的是重啓apache服務器。

而後再次從新安裝，就能夠安裝成功了。

在phpDocumentor成功安裝後，php安裝目錄下會多出來一個phpdoc.bat。這個文件就是咱們用來生成文檔的批處理文件了。
在phpdoc.bat所在目錄下，輸入
Phpdoc –h

會獲得一個phpDocumentor的詳細參數列表。
咱們從其中選出幾個經常使用的來看看：

-f
要進行分析的文件名，多個文件用逗號分割
-d
要分析的目錄，多個目錄用逗號分割
-t
生成的文檔的存放路徑
-o
輸出的文檔格式，結構爲輸出格式:轉換器名:模版目錄，例如：HTML:frames:phpedit

咱們會用到的就這幾個了，其餘的命令請你們閱讀help的提示信息。

試用phpDocumentor
下面演示一下如何使用phpDocumentor來生成文檔。
首先，把咱們須要的參數肯定下來：

-d
D:\www\demo
-t
D:\docs
-o
HTML:frames:phpedit

根據上邊的參數，咱們組合出下邊的命令：
Phpdoc -d 「D:\www\demo」 -t 「D:\docs」 -o 「HTML:frames:phpedit」

運行上邊的命令後，phpDocumentor開始解析源文件並輸出工做信息。

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

上邊的圖很清楚地描述出了文檔的內容：
索引、函數列表、類列表、文件列表和子包。
點擊上邊的class(es)連接，咱們能夠清晰的看見整個包的class tree。

咱們點擊其中一個class，就進入了class的描述頁面。
Class描述頁面主要包含如下幾方面內容：

l 描述：版權、做者、類層次等
l 類變量
l 類常量
l 方法
l 繼承的變量
l 繼承的方法：很是有用的一個功能

怎麼樣，是否是很詳細呢？若是要生成chm，能夠把前邊的-o參數改成」CHM:default: default」，這樣phpDocumentor會爲你生成好chm項目文件，只要用微軟的chm工具進行編譯就能夠獲得可用的chm文件了。

用phpDocumentor爲本身的代碼生成文檔
雖然phpDocumentor能夠自動從代碼中分析出一些信息，可是，要造成一份詳盡的文檔仍是須要咱們在編碼中進行配合的。爲了讓phpDocumentor讀懂咱們的代碼，咱們須要注意一些編碼規範和在註釋中增長一些tag：

@author 做者信息
@const 由define定義的常量
@deprecate 不建議使用的API
@global 全局變量
@package 包信息
@param 函數參數
@return 返回值
@see 參考函數
@since 引入時間
@static 靜態變量
@var 類成員變量

/*** @name 名字* @abstract 申明變量/類/方法* @access 指明這個變量、類、函數/方法的存取權限* @author 函數做者的名字和郵箱地址* @category 組織packages* @copyright 指明版權信息* @const 指明常量* @deprecated 指明不推薦或者是廢棄的信息* @example 示例* @exclude 指明當前的註釋將不進行分析，不出如今文擋中* @final 指明這是一個最終的類、方法、屬性，禁止派生、修改。* @global 指明在此函數中引用的全局變量* @include 指明包含的文件的信息* @link 定義在線鏈接* @module 定義歸屬的模塊信息* @modulegroup 定義歸屬的模塊組* @package 定義歸屬的包的信息* @param 定義函數或者方法的參數信息* @return 定義函數或者方法的返回信息* @see 定義須要參考的函數、變量，並加入相應的超級鏈接。* @since 指明該api函數或者方法是從哪一個版本開始引入的* @static 指明變量、類、函數是靜態的。* @throws 指明此函數可能拋出的錯誤異常,極其發生的狀況* @todo 指明應該改進或沒有實現的地方* @var 定義說明變量/屬性。* @version 定義版本信息*/