phpDocumentor 是專為 PHP 5 設計的文檔生成工具,能自動解析原始碼中的類、函數、方法定義與關聯關係,支援輸出 HTML、CHM、PDF 等多種格式,大幅降低 API 文檔維護成本。
# 透過 PEAR 安裝
pear install phpDocumentor
# 安裝完成後會在 PHP 目錄產生 phpdoc.bat
| 參數 | 用途 |
|---|---|
-f | 指定解析檔案(多檔以逗號分隔) |
-d | 指定解析目錄(多目錄以逗號分隔) |
-t | 文檔輸出目標路徑 |
-o | 輸出格式:轉換器:模板(如 HTML:frames:phpedit) |
phpdoc -d "C:\Program Files\EasyPHP5\php\PEAR\PHPUnit2" \
-t "C:\Program Files\EasyPHP5\php\phpunit2doc" \
-o "HTML:frames:phpedit"
執行完成後,於目標目錄開啟 index.html 即可瀏覽三欄式框架文檔:左上套件資訊、左下導航、右側詳細內容。
為生成豐富文檔,原始碼需遵循標準註解格式:
@author 作者資訊@param 函數參數說明@return 返回值描述@package 套件歸屬@see 相關參考@var 類成員變數型別-o 參數改為 CHM:default:default,再用 Microsoft HTML Help Workshop 編譯。