快捷導(dǎo)航

php文檔工具PHP Documentor安裝與使用方法

更新時(shí)間：2016年01月25日 14:18:11 作者：張映

這篇文章主要介紹了php文檔工具PHP Documentor安裝與使用方法,較為詳細(xì)的分析了在Linux平臺(tái)安裝與使用PHP Documentor的方法,需要的朋友可以參考下

本文講述了php文檔工具PHP Documentor安裝與使用方法。分享給大家供大家參考，具體如下：

PHP Documentor是PEAR下面的一個(gè)模塊，用來(lái)生成文檔。PHP Documentor掃描指定目錄下面的php源代碼，掃描其中的關(guān)鍵字，截取需要分析的注釋?zhuān)缓蠓治鲎⑨屩械膶?zhuān)用的tag，生成html文件，接著根據(jù)已經(jīng)分析完的類(lèi)和模塊的信息，建立相應(yīng)的索引，生成html文件。在review代碼的時(shí)候，有點(diǎn)用處。

一、安裝PHP Documentor

首先要先確認(rèn)一下有沒(méi)有安裝pear庫(kù)，

; UNIX: "/path1:/path2" 
include_path = ".:/usr/share/pear" //pear庫(kù)位置 
; 
; Windows: "\path1;\path2" 
;include_path = ".;c:\php\includes"

如果沒(méi)有安裝http://pear.php.net/go-pear，文件另存為一下。命令行下php go-pear.php，就可以安裝了。我是用yum安裝的php，安裝的時(shí)候，pear已經(jīng)安裝了。pear安裝好后，我可以通過(guò)pear install phpDocumentor來(lái)安裝phpdoc

[apacheuser@krlcgcms01 ~]$ phpdoc -h 里面會(huì)有很多的參數(shù)，要生成html文檔，有三個(gè)參數(shù)是夠了。

-d 要分析的目錄，多個(gè)目錄用逗號(hào)分割
-t 生成的文檔的存放路徑
-o 輸出的文檔格式

二、生產(chǎn)文檔

復(fù)制代碼代碼如下:

[root@krlcgcms01 test]# phpdoc -d "/tmp/test/mytest" -t "/tmp/test/doc" -o "HTML:frames:phpedit"

上面的這句話是說(shuō)，將/tmp/test/mytest目錄下的php文件，生成文檔資料放到/tmp/test/doc下面，文檔格式html的形勢(shì)。

[apacheuser@krlcgcms01 doc]$ ls
blank.html elementindex.html li_é¦–é¡µ.html
classtrees_default.html elementindex_é¦–é¡µ.html media
classtrees_é¦–é¡µ.html errors.html packages.html
default index.html é¦–é¡µ
elementindex_default.html li_default.html

到存放生成文檔的目錄中看一下。系統(tǒng)沒(méi)有裝中文字符，所以中文亂碼。

通過(guò)瀏覽器來(lái)看一下index.html，部分內(nèi)容如果下

PHP Documentor 文檔工具

1. 從上圖中，我們可以看出，文檔中的內(nèi)容主要是把php文件中的注釋標(biāo)簽列出來(lái)，相應(yīng)的文件列出來(lái)，看著比較舒服。其他沒(méi)有什么。

注釋標(biāo)簽如下：

@author 作者信息
@const 由define定義的常量
@deprecate 不建議使用的API
@global 全局變量
@package 包信息
@param 函數(shù)參數(shù)
@return返回值
@see 參考函數(shù)
@since 引入時(shí)間
@static 靜態(tài)變量
@var 類(lèi)成員變量

2. 上圖中有亂碼的，生成的html的編輯是

復(fù)制代碼代碼如下:

把它改成gbk就不會(huì)顯示亂碼的。

希望本文所述對(duì)大家PHP程序設(shè)計(jì)有所幫助。

您可能感興趣的文章: