文檔生成工具doxygen+圖像生成工具GraphViz

雖然jdk自帶的javadoc也很好用,不過使用doxygen+GraphViz 的組合可以生成許多強大的圖(類圖、協作圖、文件包含/被包含圖、函數調用/被調用圖、類繼承體系圖等),另外,doxygen支持直接生成chm文檔,支持LaTeX公式,如果你有一個支持php的服務器,生成的html還可以加入一個搜索框。

doxygen是開源的C語言軟體,可以在它的官方網站上下載到軟體和源碼:
http://www.stack.nl/~dimitri/doxygen

使用它的doxyWizard很是方便^^ 具體用法我寫在了附件的文檔中(不過註釋是C++版,doxygen是可以使用默認的javadoc註釋的,你只需要將設定改成output for Java)。
它還可以自定義css/head/foot,由於用於內部交流於是就沒有設定,可以在Export的HTML選項卡中修改,傳說中MySQL的文檔就是doxygen生成的。。。

doxygen內置了生成類圖的功能,只需要設定Diagram的項。
要生成更多圖的請下載GraphViz。
它是一款強大的可以生成很多種圖像的軟件,同樣也是開源的:http://www.graphviz.org/
它還提供了Java支持,有一個純java編寫的子項目Grappa。按照上面的說明,似乎java程序可以通過Grappa庫來實現GraphViz的功能(Grappa調用GraphViz的接口)。

大家有興趣可以嘗試一下 挺好玩的說^^
附件是一個Doxygen使用簡介.docx,裏面包含了我這幾天玩得doxyWizard的簡單使用說明。
以及 一個使用doxyWizard生成的chm文件,只用了類圖、文件包含圖和類繼承體系圖。

Doxygen使用簡介.docx】 【DBOp.chm

生成圖演示:

  • 類圖
  • 協作圖
  • 文件包含圖
  • 函數調用圖
  • 類繼承體系圖
  • http://www.cppblog.com/prayer/archive/2009/12/24/103989.html
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章