phpdocumentor 安裝以及使用說明

一  原因       

        最近改版公司網站和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"

而後在對應的目錄下去查看生成的文檔便可！