PHP文檔工具

來源:互聯網
上載者:User
寫文檔是一項乏味卻不得不做的工作,而編寫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

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在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.