|
phpDocumentor是一個(gè)用php寫的工具,對(duì)于有規(guī)范注釋的php程序,它能夠快速生成具有相互參照,索引等功能的API文檔。老的版本是 phpdoc,從1.3.0開始,更名為phpDocumentor,新的版本加上了對(duì)php5語(yǔ)法的支持,同時(shí),可以通過(guò)在客戶端瀏覽器上操作生成文檔,文檔可以轉(zhuǎn)換為PDF,HTML,CHM幾種形式,非常的方便。
phpDocumentor工作時(shí),會(huì)掃描指定目錄下面的php源代碼,掃描其中的關(guān)鍵字,截取需要分析的注釋,然后分析注釋中的專用的tag,生成 xml文件,接著根據(jù)已經(jīng)分析完的類和模塊的信息,建立相應(yīng)的索引,生成xml文件,對(duì)于生成的xml文件,使用定制的模板輸出為指定格式的文件。
2. 安裝phpDocumentor
和其他pear下的模塊一樣,phpDocumentor的安裝也分為自動(dòng)安裝和手動(dòng)安裝兩種方式,兩種方式都非常方便:
a. 通過(guò)pear 自動(dòng)安裝
在命令行下輸入
pear install phpDocumentor
b. 手動(dòng)安裝
在http://manual.phpdoc.org/下載最新版本的phpDocumentor(現(xiàn)在是1.4.0),把內(nèi)容解壓即可。
3.怎樣使用phpDocumentor生成文檔
命令行方式:
在phpDocumentor所在目錄下,輸入
php 主站蜘蛛池模板: 万源市| 旬阳县| 铁岭县| 南昌县| 木兰县| 山西省| 榆中县| 盐边县| 阿尔山市| 镶黄旗| 武平县| 湄潭县| 临江市| 榕江县| 阿荣旗| 德昌县| 建宁县| 浑源县| 手游| 耒阳市| 六安市| 新昌县| 分宜县| 台南市| 天柱县| 扶沟县| 白城市| 读书| 积石山| 都安| 乐清市| 即墨市| 四川省| 汽车| 织金县| 海阳市| 得荣县| 铅山县| 东丰县| 鹤岗市| 濮阳县|