天天看點

phpdoc2操作執行個體PHPDocument對于有規範注釋的php程式,可以快速生成API文檔,以下是安裝與使用步驟:

PHPDocument對于有規範注釋的php程式,可以快速生成API文檔,以下是安裝與使用步驟:

本例環境:windows7,、PHPDocument 2.8.1、php 5.4n、Apache 2.4.9

安裝PHPDocument的方法很多,本例采用php pear安裝,pear安裝配置方法本例不再贅述。

cmd中進入php安裝目錄,依次執行:

pear channel-discover pear.phpdoc.org(注冊phpdoc)

pear remote-list -c phpdoc(擷取可安裝清單)

pear install phpdoc/phpDocumentor(執行下載下傳安裝)

phpdoc2操作執行個體PHPDocument對于有規範注釋的php程式,可以快速生成API文檔,以下是安裝與使用步驟:

安裝過程需要下載下傳檔案

phpdoc2操作執行個體PHPDocument對于有規範注釋的php程式,可以快速生成API文檔,以下是安裝與使用步驟:

安裝完成,使用方法:

phpdoc -d "原項目絕對路徑" -t "生成api文檔的路徑"

詳細參數可執行 phpdoc -h 進行查詢

生成出的html格式文檔,可能會出現頁面響應時間過長的問題,原因可能是頁面對googleapis的引用,修改位置如下:

phpdoc2操作執行個體PHPDocument對于有規範注釋的php程式,可以快速生成API文檔,以下是安裝與使用步驟:

若安裝使用的為PHPDocument 1.x版本,安裝和使用過程與此稍有不同。

需要注意的是1.x版本可能會出現生成文檔頁面不顯示或是亂碼問題,需要對模闆檔案做一些修改:

模闆位置在 \pear\PhpDocumentor\data\templates

本例模闆位置:E:\phpStudy\php54n\pear\PhpDocumentor\data\templates

修改檔案(不完全):

header.tpl、index.tpl

删除 <?xml version="1.0" encoding="iso-8859-1"?>

修改 iso-8859-1 => utf-8