PhpDocumentor 2安裝以及生成API文檔的方法
官網(wǎng)地址:http://www.phpdoc.org/
項(xiàng)目地址:https://github.com/phpDocumentor/phpDocumentor2
phpDocumentor 2是一個(gè)可以 分析php源代碼和注釋塊并生成文檔的程序。
基于phpdocumentor 1和javadoc啟發(fā)而來(lái),它持續(xù)創(chuàng)新的使用了一些新技術(shù)和支持php的新特性。
phpDocumentor 2的特點(diǎn):
兼容php5.3,全面支持命名空間和閉包等。
識(shí)別支持任何tag,以及一些追加的 (比如 @link).
更快的處理速度。 較 phpDocumentor 1在Zend Framework 下的處理耗時(shí)有了明顯的減少。
低內(nèi)存消耗,小中大型工程的內(nèi)存消耗分別低于20MB,40MB和100MB。
增量解析。如果你有之前運(yùn)行phpdoc獲得的structure.xml文件,那么小修改后重新生成文檔的速度將提升80%。
簡(jiǎn)單就能創(chuàng)建模板,只需1小步和編輯3個(gè)文件。
兼容1代的命令行。例如 --directory, --file and --target
兩步式處理。首先生成structure文件,你可以根據(jù)這個(gè)文件來(lái)格式化相關(guān)信息,用自己的工具來(lái)展現(xiàn)信息!
安裝需求:
PHP 5.3.3 or higher
ext/iconv, http://php.net/manual/en/book.iconv.php (從PHP 5.0.0版本起,默認(rèn)開啟)
ext/intl, http://php.net/manual/en/book.intl.php
The XSL extension, http://www.php.net/manual/en/book.xsl.php (可選,只在使用xsl的模板時(shí)使用)
Graphviz (可選,用來(lái)生成類圖)
安裝phpDocumentor 2
1.依賴于 pear 進(jìn)行安裝:
下載 pear http://pear.php.net/go-pear.phar
將 go-pear.phar 放到 PHP 目錄下
執(zhí)行安裝命令:
php go-pear.phar
下面會(huì)執(zhí)行輸入 system
然后一路回車安裝完畢
2.接下來(lái)安裝類關(guān)系繪圖用到的工具:
pear install image_graphviz
下載 http://www.graphviz.org/Download_windows.php graphviz-2.38.msi
安裝后,注意查看環(huán)境變量 path 中是否已添加上該 bin 的路徑,
下面很重要的一步:重啟電腦,否則無(wú)法生效
3.安裝 phpDocumentor
pear channel-discover pear.phpdoc.org //注冊(cè)channel
pear remote-list -c phpdoc //列出可以獲得的版本
pear install phpdoc/phpDocumentor //安裝phpDocumentor
安裝步驟完成!
提示下:
兩個(gè)軟件安裝后的目錄都在PHP 下的 pear 下面:
php/pear/PhpDocumentor
php/pear/Image
使用PhpDocumentor 2
下面開始生成項(xiàng)目文檔:
在PHP根目錄下:
phpdoc -d 項(xiàng)目絕對(duì)路徑 -t 生成的文檔存放的路徑
d代表路徑directory,t代表target?;蛘呖梢赃x擇-f來(lái)指定單個(gè)文件。制定好路徑稍等片刻執(zhí)行完畢就可以在target文件夾里看到說(shuō)明文檔了。
例子:
phpdoc -d E:\bak\video\code -t E:\bak\video\code\doc
E:\bak\video\code 為php代碼的文件夾
E:\bak\video\code\doc 為生成文檔的文件夾
具體的參數(shù)如下:
project:run [-t|--target[="..."]] [-f|--filename[="..."]] [-d|--directory[="..."]] [-e|--extensions[="..."]] [-i|--ignore[="..."]] [--ignore-tags[="..."]] [--hidden] [--ignore-symlinks] [-m|--markers[="..."]] [--title[="..."]] [--force] [--validate] [--visibility[="..."]] [--defaultpackagename[="..."]] [--sourcecode] [-p|--progressbar] [--template[="..."]] [--parseprivate] [-c|--config[="..."]]
- Python文檔生成工具pydoc使用介紹
- eclipse中自動(dòng)生成javadoc文檔的方法
- PHP使用DOMDocument類生成HTML實(shí)例(包含常見標(biāo)簽元素)
- 探討:如何使用PhpDocumentor生成文檔
- Java讀取Excel文件內(nèi)容的簡(jiǎn)單實(shí)例
- Java數(shù)據(jù)導(dǎo)出功能之導(dǎo)出Excel文件實(shí)例
- java使用poi讀取ppt文件和poi讀取excel、word示例
- java使用poi讀取excel內(nèi)容方法實(shí)例
- Java數(shù)據(jù)導(dǎo)入功能之讀取Excel文件實(shí)例
- Java多種方式動(dòng)態(tài)生成doc文檔
相關(guān)文章
php下foreach提示W(wǎng)arning:Invalid argument supplied for foreach()
這篇文章主要介紹了php下foreach提示W(wǎng)arning:Invalid argument supplied for foreach()的解決方法,是很多開發(fā)者在進(jìn)行PHP程序設(shè)計(jì)的過(guò)程中經(jīng)常會(huì)遇到的問題,需要的朋友可以參考下2014-11-11PHP連接數(shù)據(jù)庫(kù)實(shí)現(xiàn)頁(yè)面增刪改查效果
這篇文章主要介紹了如何利用PHP實(shí)現(xiàn)連接SQL數(shù)據(jù)庫(kù),從而對(duì)頁(yè)面進(jìn)行增刪改查功能,文中的示例代碼講解詳細(xì),感興趣的可以了解一下2022-03-03學(xué)習(xí)php設(shè)計(jì)模式 php實(shí)現(xiàn)訪問者模式(Visitor)
這篇文章主要介紹了php設(shè)計(jì)模式中的訪問者模式,使用php實(shí)現(xiàn)訪問者模式,感興趣的小伙伴們可以參考一下2015-12-12php實(shí)現(xiàn)驗(yàn)證郵箱格式的代碼實(shí)例
在本篇文章里小編給大家整理的是關(guān)于php實(shí)現(xiàn)驗(yàn)證郵箱格式的代碼實(shí)例以及相關(guān)知識(shí)點(diǎn),需要的朋友們參考下。2020-01-01PHP實(shí)現(xiàn)數(shù)組根據(jù)某個(gè)單元字段排序操作示例
這篇文章主要介紹了PHP實(shí)現(xiàn)數(shù)組根據(jù)某個(gè)單元字段排序操作,結(jié)合實(shí)例形式分析了php基于array_multisort函數(shù)降序排序操作相關(guān)實(shí)現(xiàn)技巧,需要的朋友可以參考下2018-08-08