寫文檔是一項乏味卻不得不做的工作,而編寫API級的文檔更是意味著大量的重復勞動和難以保持的一致性。這裡我們要推薦給大家的,是支持PHP5語法分析的文檔工具——phpDocumentor。
使用phpDocumentor不僅可以自動從代碼中提取出函數和方法定義,還可以自動處理各個class之間的關系,並據此生成class tree。你還可以選擇將文檔生成html、chm或者pdf。有了phpDocumentor,文檔工作變得輕松了很多。
安裝phpDocumentor
在pear下安裝phpDocumentor是一件極其簡單的事情,只需要在cmd窗口中cd 到php安裝目錄下,然後輸入
Pear install phpDocumentor
Pear就會自己下載並完成phpDocumentor的安裝。
在phpDocumentor成功安裝後,php安裝目錄下會多出來一個phpdoc.bat。這個文件就是我們用來生成文檔的批處理文件了。
<? 相關知識 ?>
phpDocumentor是phpDoc的升級版本,是專門為支持php5語法而重寫的文檔工具,當你的php版本為5時,運行phpDoc.bat,它會自動去調用phpDocumentor。所以文章中的提到的phpDoc和phpDocumentor實際上是相同的。
在phpdoc.bat所在目錄下,輸入
Phpdoc