為了解決一校友在安裝和使用phpDocumentor過程中遇到的問題,自己閑時也折騰了一下這個東西,總結見下:
一.定義:
自己剛聽到這個詞時還不知道這個是什么東西,干啥用的,就去百度了一下,說道:
"phpDocumentor是用php語言寫的一個非常強大的文檔自動生成工具,利用它可以幫助我們編寫規范的注釋,生成易於理解,結構清晰的文檔,對我們的代碼升級,維護,移交等都有非常大的幫助”;
二.安裝:
我實驗的環境是win8 + wamp集成環境(php5.4.16),
首先是查看自己的php.exe同目錄下是否存在pear這個文件,比如我的php.exe是E:\wamp\bin\php\php5.4.16
如果沒有就點擊這個http://pear.php.net/go-pear.phar下載go-pear.phar文件,然后將下載的文件放到php.exe同目錄下,比如我的是放在E:\wamp\bin\php\php5.4.16
為了防止出現權限不夠導致的錯誤(以前就被坑過),我使用管理員的權限(這個很重要)進入到dos,win8如下
其他的win系統可以查看 http://jingyan.baidu.com/article/e73e26c0f87c2424adb6a7f1.html
然后在dos命令行中切換到php.exe目錄下,輸入php go-pear.phar,如下圖:
按回車默認system然后繼續。以下是默認的pear的臨時、數據、配置、測試、執行目錄的設置:
按下回車提示如下:
就這么簡單的安裝成功了,查看php.exe同目錄就可以看到pear這個文件了
然后執行操作 pear install PhpDocumentor
上面那個警告說明PhpDocumentor已經不是最新的了,以后用phpdocumentor這種寫法(pear install phpdocumentor)
看到這個install ok 就說明PhpDocumentor安裝成功了!
同時在我的這個目錄下
E:\wamp\bin\php\php5.4.16\pear
會有以下文件
三.使用PhpDocumentor
輸入phpdoc -h會有以下提示
用到最多的幾個參數:
-f 要進行分析的文件名,多個文件用逗號隔開
-d 要分析的目錄,多個目錄用逗號分割
-t 生成的文檔的存放路徑
-o 輸出的文檔格式,結構為輸出格式:轉換器名:模板目錄。
執行以下命令:
phpdoc -o HTML:frames:earthli -f E:\www\webdev2\trunk\include\Controller\EsfController.php -t docs (其中EsfController.php是php代碼的路徑, docs是生成的html API的存放路徑)
然后查看docs的目錄如下會有html API
E:\wamp\bin\php\php5.4.16\docs\Include\Controller
用瀏覽器訪問那個API會得到如下結果
參考博客:
http://www.cnblogs.com/bugY/archive/2012/07/06/2578972.html
http://luchuan.iteye.com/blog/954147
http://blog.163.com/chen_r200509/blog/static/3411130020098294223106/