[PHP] phpDocument文件產生_步驟簡易說明

[安裝]
phpDocument是PHP自家pear成員之一
因此要先安裝好php
然後在php資料夾下找到一個「go-pear.bat」
執行後按照它的步驟一一完成(雖然是Dos畫面很不親和)

現在你的php\PEAR\下有一些檔案了
請開一個cmd(DOS環境)去執行「pear.bat」
例如D:\program\php\pear.bat  install -o PhpDocumentor
在PEAR夾下會有PhpDocument的資料夾~

前面兩步驟都會遇到問題回報，基本上就照它預設去跑吧
以上是用pear方式安裝；另外一種方式是直接在官網上抓檔下來解壓縮後即可用

而後我們需要用到的就是「phpdoc.bat」這個檔，是說每個人的檔案位置不同
可以進dos去用這個執行檔產出文件，亦可直接打phpdoc





[程式]
官網上有介紹註釋有那些特定用途的語法可用http://www.phpdoc.org/docs/latest/for-users/list-of-tags.html
像@author (作者)再常用不過了！



[產出文件]
C:\> phpdoc --parseprivate -o HTML:frames:earthli -f D:\code\index.php -t D:\code\docs
也可以
C:\> phpdoc -o HTML:Smarty:PHP -d D:\code\ -t D:\code\docs

--parseprivate    是將私有(private)的成員函式變數都加入文件，不然只會顯示public or protected的
-f    指針對某個檔案做文件
-d   指針對某個目錄(含子目錄)來做文件
-t    指定要輸出的目錄位置
-o    指定要輸出的格式

執行後，就到D:\code\docs\(你指定輸出的位置)找到index.html就可以點開來使用
真是太方便啦~




[備註]很煩人的是，這套的預設編碼為ISO-8859-1......所以產出的html預設也就.....冏



//20120507補充
官網可用樣版
-o 參數格式為 "輸出方式:轉換工具:樣板目錄"
例如 HTML:frames:earthli
HTML   為輸出方式
frames 為轉換工具
earthli   為樣板目錄

內建的格式如下

HTML:frames:default
HTML:frames:earthli
HTML:frames:l0l33t
HTML:frames:phpdoc.de
HTML:frames:phpedit
HTML:frames:phphtmllib

HTML:Smarty:HandS
HTML:Smarty:PHP
HTML:Smarty:default

PDF:default:default

CHM:default:default
以上用frames做轉換都會有亂碼的產生