|
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 主站蜘蛛池模板: 巴塘县| 红安县| 繁峙县| 徐闻县| 于田县| 南乐县| 天长市| 绵阳市| 湖北省| 龙山县| 安化县| 长宁区| 博白县| 白城市| 乡城县| 纳雍县| 丰镇市| 海宁市| 新宁县| 名山县| 苗栗县| 辉南县| 叙永县| 茂名市| 禹城市| 龙岩市| 杨浦区| 拜城县| 余干县| 延安市| 永仁县| 洮南市| 灵武市| 福州市| 申扎县| 平罗县| 社会| 乌拉特中旗| 普定县| 正定县| 哈密市|