好久沒寫新東西了。

最近遇到很頭疼的事，好多代碼要維護，時間長了，自己寫過的代碼都想不起來。

要調用某個對象的方法，每次都要打開那個類定義的 PHP 文件，找到方法的定義部分，然后仔細看看參數列表才能想起來怎么用。

最麻煩的是，有時候想不起來那個方法是在哪個類里面定義的，必須得去代碼根目錄 grep ，然后等半天……

相對比的，我開發程序時，手邊必備的幾個文檔：PHP手冊、MySQL手冊、HTML手冊、CSS手冊、Javascript手冊，以及最近開始用的 ActionScript手冊。這些都是 chm 版本的！

Chm 幫助文件有 2 個最大的好處，一個是索引，另一個是全文檢索。

用索引可以一邊輸入，一邊過濾掉不匹配的關鍵詞，迅速定位到想要的那個函數名。

當不知道關鍵詞是什么的時候，可以用 like 語句在 chm 文件里面的每一句話中匹配關鍵詞。

原本，用 Zend Studio 也有代碼提示和自動完成，不過這個用 Java 虛擬機運行的 IDE 實在是慢，受不了，也不習慣。

今天花了好長時間，研究 php 文檔生成工具，找到了幾個，主要都是生成 html 頁面的，而且格式很難看，重要的是沒有好用的索引，更沒有全文搜索，沒意思。

PhpDocumentor 支持 chm 生成，這個讓我眼前一亮！

簡單看了下官方文檔，然后就下載了 zip 格式的壓縮包，就是這個壓縮包，浪費了我好長時間去調試錯誤！！

設定好 php 源碼路徑，再設置文檔格式，選擇 chm，輸出了一堆文件，包含 hhc，hhp 等，這些是 chm 的“源碼”，需要用 Windows 自帶的 HTML Help WorkShop 進行編譯，然后才能生成 chm。

而那個 zip 壓縮包，居然是有嚴重 bug 的版本，生成的 hhc 文件，里面有一行錯誤代碼，提示 contents.hhc.tpl 找不到！！！

最開始我沒有意識到問題在這里，只是用 WorkShop 反復編譯那堆 hhc 文件，總是不成功！我都有放棄的念頭了。

后來仔細看錯誤提示，好像是 hhc 文件的問題，打開一看，才知道是上述原因。

再去 phpDocument 源碼里面找 contents.hhc.tpl，真的沒有！不過，卻有 contents.hhc.tp 這個文件！！！

然后列了下目錄，幾十個文件，大部分都是 tpl 擴展名，而有幾個文件是 tp！！！

靠！什么玩意兒，是程序員馬虎了還是打包工具的問題？

重新下了個 tgz 版本的 phpDocument，問題全無，chm 編譯順利！

另外，默認編譯的 chm 是不帶搜索(全文檢索)功能的，更改方式如下：

打開一個項目文件，單擊“Project(項目)”選項卡的“Change project options(改變項目選項)”，在“Options(選項)”對話框的“Compiler(編譯)”選項卡中選中“Compile Full Text Search Information(編譯全文搜索信息)”即可。

附贈命令行范例：

$> php phpdoc -o CHM:default:default -d ../lib/ -t ../docs/ > ../php_doc.log

總結

以上是生活随笔為你收集整理的php chm生成工具,phpDocumentor PHP 文档生成 CHM的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。