phpdocmentor安裝使用詳解

安裝phpDocumentor

在pear下安裝phpDocumentor是一件極其簡單的事情,只需要在cmd窗口中cd 到php目錄下,然後輸入

Pear install phpDocumentor即可。

09144745-ce7d9a6e0293438397077fbaa2fd5e9

09144805-70a3960d64474bd496bc538073f23ea


如果顯示 Pear 不是內部或外部命令,也不是可運行的程序或批處理文件。則需要先運行 php文件夾裏的 go-pear.bat 文件。直接按回車即可裝好。期間需要輸入一次y,再按任意鍵就可以了。

09144845-77b0bbb4ab3b479c8403b7ae27d98d7

然後我們再進入dos下運行 pear命令

當出現這種錯誤的時候,是因爲分配的內存不夠
有以下辦法解決:
一、修改php.ini(推薦)
memory_limit = 128M
二、在程序裏面添加如下語句
ini_set("memory_limit","128M");
三、在根目錄建立.htaccess文件,添加如下內容(注意是這種根目錄D:\wamp\php\PEAR\PEAR)
php_value memory_limit 128M
如果還不能解決,就把它改得再大一些。(介紹一個辦法建立.htaccess文件,新建一個文本文檔,然後在裏面寫好以上語句,另存爲的時候,選擇所有文件,然後文件名爲:.htaccess 即可)
最後注意的是重啓apache服務器。

然後再次重新安裝,就可以安裝成功了。

09145013-b20714d6785d43d284a7a39f0b12ba4

在phpDocumentor成功安裝後,php安裝目錄下會多出來一個phpdoc.bat。這個文件就是我們用來生成文檔的批處理文件了。
在phpdoc.bat所在目錄下,輸入
Phpdoc –h

會得到一個phpDocumentor的詳細參數列表。
我們從其中選出幾個常用的來看看:

-f
要進行分析的文件名,多個文件用逗號分割
-d
要分析的目錄,多個目錄用逗號分割
-t
生成的文檔的存放路徑
-o
輸出的文檔格式,結構爲輸出格式:轉換器名:模版目錄,例如:HTML:frames:phpedit

我們會用到的就這幾個了,其他的命令請大家閱讀help的提示信息。

試用phpDocumentor
下面演示一下如何使用phpDocumentor來生成文檔。
首先,把我們需要的參數確定下來:

-d
D:\www\demo
-t
D:\docs
-o
HTML:frames:phpedit

根據上邊的參數,我們組合出下邊的命令:
Phpdoc -d “D:\www\demo” -t “D:\docs” -o “HTML:frames:phpedit”

運行上邊的命令後,phpDocumentor開始解析源文件並輸出工作信息。

命令運行完成後,我們的文檔就已經生成好了。 進入我們指定的目標目錄,用瀏覽器打開index.html就可以看見生成的文檔了。 文檔界面由frame分成了三個部分,左上是包信息,左下是導航信息,右邊則是詳細的信息呈現頁。

上邊的圖很清楚地描述出了文檔的內容:
索引、函數列表、類列表、文件列表和子包。
點擊上邊的class(es)鏈接,我們可以清晰的看見整個包的class tree。

我們點擊其中一個class,就進入了class的描述頁面。
Class描述頁面主要包含以下幾方面內容:

l 描述:版權、作者、類層次等
l 類變量
l 類常量
l 方法
l 繼承的變量
l 繼承的方法:非常有用的一個功能

怎麼樣,是不是很詳細呢?如果要生成chm,可以把前邊的-o參數改爲”CHM:default: default”,這樣phpDocumentor會爲你生成好chm項目文件,只要用微軟的chm工具進行編譯就可以得到可用的chm文件了。

用phpDocumentor爲自己的代碼生成文檔
雖然phpDocumentor可以自動從代碼中分析出一些信息,但是,要形成一份詳盡的文檔還是需要我們在編碼中進行配合的。爲了讓phpDocumentor讀懂我們的代碼,我們需要注意一些編碼規範和在註釋中增加一些tag:

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

/**
* @name 名字
* @abstract 申明變量/類/方法
* @access 指明這個變量、類、函數/方法的存取權限
* @author 函數作者的名字和郵箱地址
* @category 組織packages
* @copyright 指明版權信息
* @const 指明常量
* @deprecated 指明不推薦或者是廢棄的信息
* @example 示例
* @exclude 指明當前的註釋將不進行分析,不出現在文擋中
* @final 指明這是一個最終的類、方法、屬性,禁止派生、修改。
* @global 指明在此函數中引用的全局變量
* @include 指明包含的文件的信息
* @link 定義在線連接
* @module 定義歸屬的模塊信息
* @modulegroup 定義歸屬的模塊組
* @package 定義歸屬的包的信息
* @param 定義函數或者方法的參數信息
* @return 定義函數或者方法的返回信息
* @see 定義需要參考的函數、變量,並加入相應的超級連接。
* @since 指明該api函數或者方法是從哪個版本開始引入的
* @static 指明變量、類、函數是靜態的。
* @throws 指明此函數可能拋出的錯誤異常,極其發生的情況
* @todo 指明應該改進或沒有實現的地方
* @var 定義說明變量/屬性。
* @version 定義版本信息
*/




發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章