php文檔工具PHP Documentor安裝與使用方法,_PHP教程

來源:互聯網
上載者:User

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


本文講述了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]$ lsblank.html elementindex.html li_首页.htmlclasstrees_default.html elementindex_首页.html mediaclasstrees_首页.html errors.html packages.htmldefault 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的編輯是
複製代碼 代碼如下:
把它改成gbk就不會顯示亂碼的。

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

您可能感興趣的文章:

  • 搭建Vim為自訂的PHP開發工具的一些技巧
  • PHP常用工具類大全附全部代碼下載
  • 再推薦十款免費的php開發工具
  • 10款實用的PHP開源工具
  • php輕量級的效能分析工具xhprof的安裝使用
  • php實現網頁緩衝的工具類分享
  • 10個簡化PHP開發的工具
  • 分享一段PHP製作的中文拼音首字母工具類
  • 當前比較流行的兩款PHP加密、解密工具Zend Guard和iconCube介紹
  • PHP管理依賴(dependency)關係工具 Composer 安裝與使用
  • 在Windows系統下使用PHP產生Word文檔的教程
  • 使用PHP匯出Word文檔的原理和執行個體

http://www.bkjia.com/PHPjc/1095680.htmlwww.bkjia.comtruehttp://www.bkjia.com/PHPjc/1095680.htmlTechArticlephp文檔工具PHP Documentor安裝與使用方法, 本文講述了php文檔工具PHP Documentor安裝與使用方法。分享給大家供大家參考,具體如下: PHP Docum...

  • 聯繫我們

    該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

    如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

    A Free Trial That Lets You Build Big!

    Start building with 50+ products and up to 12 months usage for Elastic Compute Service

    • Sales Support

      1 on 1 presale consultation

    • After-Sales Support

      24/7 Technical Support 6 Free Tickets per Quarter Faster Response

    • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.