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