Documentor怎么在php項(xiàng)目中安裝與使用

這篇文章將為大家詳細(xì)講解有關(guān)Documentor怎么在php項(xiàng)目中安裝與使用，文章內(nèi)容質(zhì)量較高，因此小編分享給大家做個(gè)參考，希望大家閱讀完這篇文章后對(duì)相關(guān)知識(shí)有一定的了解。

一、安裝PHP Documentor

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

; UNIX: "/path2:/path3" 
include_path = ".:/usr/share/pear" //pear庫(kù)位置 
; 
; Windows: "\path2;\path3" 
;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

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 類成員變量

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

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

<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>

關(guān)于Documentor怎么在php項(xiàng)目中安裝與使用就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，可以學(xué)到更多知識(shí)。如果覺(jué)得文章不錯(cuò)，可以把它分享出去讓更多的人看到。