程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> 網頁編程 >> PHP編程 >> PHP綜合 >> php文檔工具PHP Documentor安裝與使用方法

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

編輯:PHP綜合

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

PHP Documentor是PEAR下面的一個模塊,用來生成文檔。PHP Documentor掃描指定目錄下面的php源代碼,掃描其中的關鍵字,截取需要分析的注釋,然後分析注釋中的專用的tag,生成html文件,接著根據已經分析完的類和模塊的信息,建立相應的索引,生成html文件。在review代碼的時候,有點用處。

一、安裝PHP Documentor

首先要先確認一下有沒有安裝pear庫,

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

如果沒有安裝http://pear.php.net/go-pear,文件另存為一下。命令行下php go-pear.php,就可以安裝了。 我是用yum安裝的php,安裝的時候,pear已經安裝了。pear安裝好後,我可以通過pear install phpDocumentor來安裝phpdoc

[apacheuser@krlcgcms01 ~]$ phpdoc -h 裡面會有很多的參數,要生成html文檔,有三個參數是夠了。

-d 要分析的目錄,多個目錄用逗號分割
-t 生成的文檔的存放路徑
-o 輸出的文檔格式

二、生產文檔
復制代碼 代碼如下:[root@krlcgcms01 test]# phpdoc -d "/tmp/test/mytest" -t "/tmp/test/doc" -o "HTML:frames:phpedit"

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

[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

到存放生成文檔的目錄中看一下。系統沒有裝中文字符,所以中文亂碼。

通過浏覽器來看一下index.html,部分內容如果下

PHP Documentor 文檔工具

1. 從上圖中,我們可以看出,文檔中的內容主要是把php文件中的注釋標簽列出來,相應的文件列出來,看著比較舒服。其他沒有什麼。

注釋標簽如下

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

2. 上圖中有亂碼的,生成的html的編輯是
復制代碼 代碼如下:<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
把它改成gbk就不會顯示亂碼的。

希望本文所述對大家PHP程序設計有所幫助。

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved