- 綠色版查看
- 綠色版查看
- 綠色版查看
- 綠色版查看
Doxygen工具介紹
Doxygen 是一個程序的文件產生工具,可將程序中的特定注釋轉換成為說明文件。通常我們在寫程序時,或多或少都會寫上注釋,但是對于其它人而言,要直接探索程序里的注釋,與打撈泰坦尼克號同樣的辛苦。大部分有用的注釋都是屬于針對函數、類型等等的說明。所以,如果能依據程序本身的結構,將注釋經過處理重新整理成為一個純粹的參考手冊,對于后面利用您的程序代碼的人而言將會減少許多的負擔。不過,反過來說,整理文件的工作對于您來說,就是沉重的負擔。
Doxygen文件格式
* HTML
* XML
* LaTeX
* RTF (MS-Word)
* PostScript
* Unix Man Page
而其中還可衍生出不少其它格式。如有了LaTeX 文件后,就可以透過一些工具產生出PS或是PDF檔案。
在多國語言的支持方面,Doxygen 目前可支持的約有2,30種。自Doxygen 1.2.16開始支持繁體中文。所以在目前一些Open Source 的程序文檔管理器中,Doxygen 算是相當完整的一套。在程序語言處理上面,Doxygen也算是少數在Borland C++Builder 的語法下還能夠正常運作的工具之一。
本文的目的是希望在經過仔細閱讀本文之后能夠給大家一個概略性的了解。以便可以很容易的上手使用Doxygen。至于Doxygen本身的詳細使用,各位可以參考隨著Doxygen 所附的文件。實際上,Doxygen 自己的使用手冊就是使用Doxygen 產生的。您可以看到他實際上能夠產生遠比Reference Book更復雜的文件。
Doxygen程序語言
* C/C++
* Java
* Objective-C
* Python
* IDL (Corba, Microsoft及KDE-DCOP類型)
* Fortran
* VHDL
* PHP
* C#
Doxygen常見問題
配置文件(Doxyfile)錯誤
問題描述:
新手在使用Doxygen時,可能會遇到配置文件錯誤,導致文檔生成失敗。
解決方案:
檢查配置文件:確保Doxyfile文件中的每一項配置都正確無誤,特別是INPUT和OUTPUT_DIRECTORY等關鍵配置項。
使用默認配置:如果配置文件出現問題,可以嘗試使用Doxygen提供的默認配置文件??梢酝ㄟ^命令doxygen -g生成一個新的Doxyfile。
逐步調整:在新配置文件的基礎上,逐步調整配置項,直到滿足需求。
Doxygen更新日志
將bug掃地出門進行到底
優化用戶反饋的問題,提升細節體驗
華軍小編推薦:
Doxygen使用起來十分簡單,操作界面優化讓您能夠輕松找到想要的功能,快來下載吧。小編還為您精心準備了Data Loader、SQLyog、access工具、DBF Commander、DBeaver
您的評論需要經過審核才能顯示
有用
有用
有用