windows下安裝PhpDocumentor(phpdoc)筆記

標籤：style   blog   http   color   io   使用   ar   strong   檔案   

PhpDocumentor簡介

  PHPDocumentor是一個用PHP寫的工具，對於有規範注釋的php程式，它能夠快速產生具有相互參照,索引等功能的API文檔。老的版本是phpdoc，從1.3.0開始，更名為phpDocumentor，新的版本加上了對php5文法的支援，同時，可以通過在用戶端瀏覽器上操作產生文檔，文檔可以轉換為PDF,HTML,CHM幾種形式，非常的方便。

 

參考介紹：百度百科：http://baike.baidu.com/view/1269751.htm維基百科：http://en.wikipedia.org/wiki/Phpdoc   

http://en.wikipedia.org/wiki/PhpDocumentor官網：http://www.phpdoc.org/ 手冊文檔：http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.pkg.html

 

本機環境介紹：

wampIntegration Environment，php版本5.2.11

安裝目錄： D:\phpsetup\php5 

php.exe和php.ini.所在目錄： D:\phpsetup\php5 

1、確認wamp環境能正常運行。

2、開始 -> 運行 -> 輸入cmd斷行符號，切換到php.exe所在目錄

3、輸入 go-pear.bat 

 

如有問題,修改go-pear.bat如下：

@ECHO OFFset PHP_BIN=php.exe%PHP_BIN% -d phar.require_hash=0 ./PEAR/go-pear.phar Pause

這裡指令碼會詢問我們是否是選擇伺服器範圍，還是本地拷貝，我們選擇系統。預設就是選擇系統，直接斷行符號。

 

4、這裡會列出pear路徑配置，詢問我們是否修改。斷行符號接受，開始安裝pear庫。

 

5、安裝過程中，會提示我們修改php.ihi設定inclue_path,輸入“y"斷行符號繼續安裝。

注意：這裡安裝指令碼設定的是自動修改php.ini設定include_path，就我觀察，輸入“Y”斷行符號，php.ini並沒有修改成功，這裡為了保險，我們可以自己確認一遍include_path是否設定正確。

 

6、安裝完成，提示我們匯入pear環境變數註冊表檔案： D:\phpsetup\php5\PEAR_ENV.reg ，我們找到該檔案，雙擊匯入註冊表。斷行符號結束安裝。該檔案起設定pear環境變數的作用。

 

7、輸入pear，確認pear是否成功安裝，如果出現以下介面，就表示pear已經安裝成功。

 

8、安裝PhpDocumentor前的一些準備，升級pear，可能我們安裝的pear版本會有點老，故這裡要升級pear。

輸入：

pear upgrade pear

等升級完成，安裝PhpDocumentor依賴包。

輸入：

pear install XML_Parserpear install XML_Beautifier

如果出現問題：missing structures/graph.php file...

解壓 Structures_Graph-1.0.4.tgz ，將Structures目錄複寫到 PHP\pear 裡面,接著進行升級或安裝就沒有問題了。

使用CMD用pear下載的安裝包在PHP\tmp目錄裡面。

升級所有包：pear upgrade-all

查看已經安裝的包：pear list

Pear已經升級過了。

安裝本地已經存在的包：

pear install XML_Parser-1.3.4.tgzpear install tmp/PhpDocumentor-1.4.4.tgz

去掉tmp會從網路重新下載並覆蓋

 

9、安裝PhpDocumentor

輸入：

pear install PhpDocumentor

安裝當地套件： pear install tmp/PhpDocumentor-1.4.3.tgz 

提示安裝成功

 

10、輸入  phpdoc -h ，得到所示，就表示安裝成功了。 

 

 

11、使用phpdoc

 

最簡單的用法是

phpdoc -d [SOURCE_PATH] -t [TARGET_PATH]

d代表路徑directory，t代表target。或者可以選擇-f來指定單個檔案

制定好路徑稍等片刻執行完畢就可以在target檔案夾裡看到說明文檔了

例：phpdoc -f D:\phpsetup\php5\docs\PhpDocumentor\Documentation\tests\bug-441275.php -t new\

 

但這樣不支援中文,我們使用下面的-o HTML:Smarty:PHP選項：

phpdoc -o HTML:Smarty:PHP -f d:\phpsetup\php5\tmp\test.php -t new

 

 

這樣子的意思是說，採用 HTML:Smarty:PHP 的樣板格式，然後原始碼檔案是d:\phpsetup\php5\tmp\test.php，接著把產生的檔案放在當前new目錄下。

當中若是你只要針對一個目的話，可以把 -f 改成 -d 然後後面接的著就是指定的檔名。

 

樣板的格式基本上有 HTML, XML, PDF, CHM 四大類別，通常我用的都是 HTML:Smarty:PHP 這個，因為他比較好看!

 

另外還有就是 CHM:default:default 這個.用來產生 chm 的，不過他產生出來的是 .hhp 檔案，也就是還沒有經過 HTML helper 編譯過的檔案，所以要另外安裝 HTML Helper 來編譯 hhp 檔案就可以產生你要的檔案。

 

-- 最後來說一下怎麼寫註解 --

 

phpDocumentor 的註解有一定的規格，但是都跟我們原來寫註解的方式很像，只是要注意一下東西而已。

簡單的來看個範例好了

範例：test.php

<?php/*** 這裡是這個物件的說明* 可以多行喔!~**/class MyClass {   /**   * 這裡是變數的說明   * @var int   */   var $a ;   /**   * 這裡是變數的說明.   *   * @var string 這裡也可以放說明   */   var $b ;   /**   * 這是針對函式的說明   * 也是一樣可以多行   * 若是簡單的範例也可以放這裡   * @param int $a 可以放入傳入的型態   * @return array 可以說明回傳的型態   */   function first ( $a ) {      return array();   }}?>

 

基本上都是在

/****/

中間寫註解，別忘了每行前面要有個 * 喔!

 

註解比較常用到參數的應該是

 

@author 程式作者名稱，聯絡方式@const 常數@deprecate 不建議使用的 API@global 全域變數@param 函數的參數@return 回傳值@see 可參考函數@since 開始時間@static 靜態變數@var 物件成員變數@todo 計劃中要進行的項目

 

如果覺得本文有收穫，記得推薦一下哦！^_^

 

windows下安裝PhpDocumentor(phpdoc)筆記