PHPDocumentor安裝與使用以及一般問題的處理

一、安裝PHPDocumentor

1、Pear安裝

a、可以一步步安裝，開始安裝相關依賴包，依賴包有2個，分别是XML_Parser和XML_Beautifier

在指令行中輸入pear install XML_Parser安裝XML_Parser。

D:/Program Files/PHP>pear install XML_Parser

在指令行中輸入pear install XML_Beautifier安裝XML_Beautifier。

D:/Documents and Settings/Administrator>pear install XML_Beautifier

下面才正式安裝PHPDocumentor

在指令行中輸入pear install PhpDocumentor安裝PhpDocumentor。

D:/Documents and Settings/Administrator>pear install PhpDocumentor

b、當然，一步步安裝比較麻煩，還有一種一步到位的安裝方式

進入dos的php目錄

輸入pear install -a PhpDocumentor

D:/Documents and Settings/Administrator>pear install -a PhpDocumentor

2、手動安裝

下載下傳後，如果希望使用指令行接口，解壓到任意路徑（假設在C:/Program Files/），

修改C:/Program Files/PhpDocumentor-1.4.2/phpdoc.bat

把第一行修改SET phpCli=C:/usr/local/php/cli/php.exe

令等号右邊的值為php.exe的路徑

我的機器是SET phpCli=D:/php5/php.exe

在指令行輸入C:/Program Files/PhpDocumentor-1.4.2/phpdoc,其實是一個批處理檔案

會出現一個dos界面，給你選擇ini檔案。

後面就不知道了。

如果想使用web接口，你必須先把apache和php裝好，把PhpDocumentor-1.4.2這個檔案夾

拷貝到文檔根目錄下，然後在浏覽器url欄輸入：

http://localhost/PhpDocumentor-1.4.2/phpdoc.php

然後浏覽器會自動跳轉，選擇index.html,後面的操作就很簡單了。

二、使用

a、Doc下面的指令方式

相關說明：如果需要把對應目錄中所有的檔案都生成文檔，那使用下面指令

phpdoc -o HTML:Smarty:PHP -d D:/install/apachephp/wamp/www/thinkphp -t D:/install/apachephp/phpdoc/thinkphp

相關說明：如果需要把對應目錄中某個檔案生成文檔，那使用下面指令

phpdoc -o HTML:Smarty:PHP -f D:/install/apachephp/wamp/www/thinkphp/infile.php -t D:/install/apachephp/phpdoc/thinkphp

具體的指令用法，請使用phpdoc -h檢視去比較，以上都是生成HTML文檔

b、WEB界面生成

在新的phpdoc 中，除了在指令行下生成文檔外，還可以在用戶端浏覽器上操作生成文檔，具體方法是先把PhpDocumentor 的内容放在apache 目錄下使得通過浏覽器可以通路到，通路後顯示如下的界面：

點選files 按鈕，選擇要處理的php 檔案或檔案夾，還可以通過該指定該界面下的Files to ignore 來忽略對某些檔案的處理。

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

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

Total Documentation Time: 1 seconds

done

Operation Completed!!

然後，我們就可以通過檢視生成的文檔了，如果是pdf 格式的，名字預設為documentation.pdf 。

三、中文亂碼問題

a、Zend中使用

下面的目錄便是模闆檔案存放處：

　　C:/Program FilesZendZend Studio for Eclipse - 6.0.1/plugins/com.zend.php.phpdocumentor_6.0.1.v20080601/Resources/phpdocumentor/phpDocumentor/Converters/HTML/frames/templates/default/templates

　　而且模闆結構良好，隻需要修改head.tpl、index.tpl、blank.tpl、top_frame.tpl等檔案，将其中的 ISO-8859-1改成GBK編碼方式即可，而樣式檔案的修改同樣如此，如修改stylesheet.css，先找到

　　C:/Program FilesZendZend Studio for Eclipse - 6.0.1/plugins/com.zend.php.phpdocumentor_6.0.1.v20080601/Resources/phpdocumentor/phpDocumentor/Converters/HTML/frames/templates/default/templates/media

目錄下的檔案，然後進行修改即可。

　　注意：上述修改是針對預設的php文檔樣式進行的，phpdoc提供了多款樣式，為了修改對應樣式的模闆和樣式檔案，隻需要替換上述位址中的default為樣式名稱即可找到檔案所在位址

b、

自己安裝的話，那就直接搜尋utf-8，然後把搜尋到的所有都替換成自己的編碼，例如GBK等，儲存就可了啦；