您好,登錄后才能下訂單哦!
寫文件是一個程序設計師最痛苦的事情之一,尤其是程序寫好后有人要你把function、class等等寫成一份文件。不管你是寫c/c++,perl,ruby,php都不例外。
phpdocumentor是我們的就行,只要在寫程序的時候,多寫一點注釋,范例、說明,注意一下格式,等到程序完工后,只要一個指令,就可以立刻把全部程序的說明文件產生出來,而且還有多種樣式可以選擇,甚至可以做成PDF,CHM。下面是安裝過程。
phpDocumentor本身已經是pear的成員之一,所以安裝的時候只要用pear來安裝即可。安裝之前先確保你的電腦上已經有php。
一、安裝pear
curl -o go-pear.php http://pear.php.net/go-pear.phar
/usr/local/php/bin/php go-pear.php #執行這條命令之后按回車執行安裝。
二、安裝DB
下面通過pear來安裝PHP-PEAR_DB庫
wget download.pear.php.net/package/DB-1.7.14.tgz
pear install DB-1.7.14.tgz #安裝DB庫
pear install phpDocumentor #安裝phpDocumentor
安裝完畢。下面測試
三、測試
phpdoc -o HTML:Smarty:PHP -d /home/wwwroot/polyguide/application/controllers/app -t /home/phpdocument
#執行完畢之后就可以到/home/phpdocument目錄下查看文檔了。注意,打開可能是亂碼。需要更改瀏覽器的編碼格式成“UTF-8”。
命令說明:
采用 HTML:Smarty:PHP 的格式,-d后面接的是你的程序放置目錄,-t是將生成的文件放在哪個目錄下。如果你只要對一個文件生成的話,把-d改成-f。-f后面就是你要對哪個文件生成文檔。文檔的格式基本上有HTML,XML,PDF,CHM四大類別。
本篇文檔是我安裝的時候經由多篇博客匯聚而來。感謝@蒜容黃瓜的博客 @鳥哥のlinux
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。