一 緣由
最近改版公司網站和app端的api，發現很多函數和方法都沒寫注釋，搞得每次調用之前還需要看底層實現，有的方法名和功能還類似，區分不出使用哪個最優！為了避免給后人挖坑，除了將代碼寫得規范外，還想自動生成api文檔，方便后來人！於是就研究上了phpdocumentor。今天說下它的安裝以及使用。首先需要聲明的是，網站的教程很多，但問題在於，按照網上的一些教程來，坑爹，老失敗。於是干脆自己動手寫一篇，記錄下自己的經歷。
二 安裝
安裝的環境是win10+xampp，
1 php.exe的路徑是：C:\xampp\php；首先就是查看自己的php.exe目錄下有無pear這個文件，好吧，我這個是沒有的。那么， 將https://pear.php.net/go-pear.phar另存為go-pear.phar文件，並保存到php.exe所在路徑中
2 第二步很重要，很多文章中都是說，直接進入到php的安裝目錄，執行命令 php go-pear.phar
問題就出在這里：報錯，提示 ：
PHP Warning: mkdir(): File exists in phar://C:/xampp/php/go-pear.phar/System.php on line 294
Warning: mkdir(): File exists in phar://C:/xampp/php/go-pear.phar/System.php on line 294
PHP Warning: mkdir(): No such file or directory in phar://C:/xampp/php/go-pear.phar/System.php on line 294
Warning: mkdir(): No such file or directory in phar://C:/xampp/php/go-pear.phar/System.php on line 294
Unable to create Temporary directory for processing C:\xampp\php\phpdoc\tmp.
Run this script as administrator or pick another location.
C:\xampp\php>PHP Warning: mkdir(): File exists in phar://C:/xampp/php/go-pear.phar/System.php on line 294
Could not open input file: Warning:
如圖所示：
找了好久，終於找到原因了：權限不夠導致的！！！需要以管理員的權限進入到dos下，我直接在C:\Windows\System32目錄下，以管理員的方式進入dos中：
然后切換到剛才的目錄下，執行 php go-pear.phar， 按回車默認system然后繼續。后面操作均為默認。最后成功安裝，查看php.exe同目錄就可以看到pear這個文件了：
安裝成功后，再來執行pear install phpdocumentor即可。
三 使用phpdocumentor
輸入phpdoc -h 會有如下提示：
一般，用得多的幾個參數解釋如下：
-f 要進行分析的文件名，多個文件用逗號隔開
-d 要分析的目錄，多個目錄用逗號分割
-t 生成的文檔的存放路徑
-o 輸出的文檔格式，結構為輸出格式：轉換器名：模板目錄。
例如，我這邊生成doc的命令是：
phpdoc -d "C:\www\web" -t "C:\www\web\doc"
然后在對應的目錄下去查看生成的文檔即可！