|
phpDocumentor 是一個用php寫的工具,對于有規范注釋的php程序,它能夠快速生成具有相互參照,索引等功能的API文檔。老的版本是 phpdoc,從1.3.0開始,更名為phpDocumentor,新的版本加上了對php5語法的支持,同時,可以通過在客戶端瀏覽器上操作生成文檔,文檔可以轉換為PDF,HTML,CHM幾種形式,非常的方便。
phpDocumentor工作時,會掃描指定目錄下面的php源代碼,掃描其中的關鍵字,截取需要分析的注釋,然后分析注釋中的專用的tag,生成 xml文件,接著根據已經分析完的類和模塊的信息,建立相應的索引,生成xml文件,對于生成的xml文件,使用定制的模板輸出為指定格式的文件。
2. 安裝phpDocumentor
和其他pear下的模塊一樣,phpDocumentor的安裝也分為自動安裝和手動安裝兩種方式,兩種方式都非常方便:
a. 通過pear 自動安裝
在命令行下輸入
pear install phpDocumentor
b. 手動安裝
在http://manual.phpdoc.org/下載最新版本的phpDocumentor(現在是1.4.0),把內容解壓即可。
3.怎樣使用phpDocumentor生成文檔
命令行方式:
在phpDocumentor所在目錄下,輸入
php 主站蜘蛛池模板: 安吉县| 屯昌县| 利津县| 沿河| 城市| 洞头县| 高青县| 黔东| 甘洛县| 崇阳县| 阿鲁科尔沁旗| 马鞍山市| 繁峙县| 成都市| 石城县| 仪征市| 措勤县| 泰来县| 长葛市| 长兴县| 清水县| 连南| 崇左市| 南昌县| 綦江县| 哈尔滨市| 乌兰察布市| 福鼎市| 梁河县| 禹城市| 东安县| 响水县| 安福县| 淮阳县| 农安县| 临邑县| 镇雄县| 兰州市| 密山市| 弋阳县| 定日县|