初用Doxygen自動生成代碼說明文件與常見問題小結(jié)

ID:456280 · 發(fā)表于 2018-12-27 11:59

   以前沒有認(rèn)識到代碼注釋的重要性，后來再次拿回以前的程序來看時，看得很費勁，因為以前每寫一個文件就一種注釋風(fēng)格。    在網(wǎng)上找了一下自動生成代碼文件的軟件，發(fā)現(xiàn)Doxygen這個軟件挺好的。
   于是在網(wǎng)上找了些資料，一邊操作，一邊記錄下來，以下貼上我記錄下來的一些文檔，希望對大家有用。

1    中文問題：中文注釋在文檔中是亂碼。
解決：在expert中的INPUT選項頁的INPUT_ENCODEING中填入“GB2312”，這樣基于GB的文本編輯器生成的代碼就可以正常使用了。
2 圖形問題：無法繪制類圖協(xié)作圖等圖形。
解決：首先確保安裝了graphviz for win，注意不是wingraphviz，后者是一個graphviz的com封裝，但是doxygen并不是基于它開發(fā)的，所以裝了也沒用。然后在expert的DOT_PATH中填入graphviz的安裝路徑。接著在wizard的diagram中選擇需要生成的圖形類別就可以了。
如果出現(xiàn)無法包含.map文件的錯誤，可以將工作目錄設(shè)置成html，并將html中所有文件都清除再試。這個問題的原因還不太確定。
3 輸出chm的問題：如何輸出.chm文件。
配置時注意expert中的HTML頁：選中“GENERATE_HTMLHELP”，然后在CHM_FILE中填上想要的chm文件名。
HHC_LOCATION中輸入hhc.exe文件的路徑。hhc.exe可以通過安裝HTML Help Workshop獲得。
或者使用HTML Help Workshop來編譯Doxygen生成的html文件夾中的.hhp文件，編譯完成后即可在該html文件夾中找到對應(yīng)的chm文件。
4    Doxygen無法為DLL中定義的類導(dǎo)出文檔。
例如：
class __declspec(dllexport) CClassName:public CObject
{}
目前發(fā)現(xiàn)Doxygen無法識別出DLL中定義的類。
5 如何修改或者去掉右下腳Generated at Doxygen的文字？
打開[Expert...]的HTML頁面，然后在HTML_FOOTER中指定相應(yīng)的HTML文件即可。注意HTML_FOOTER中至少包含BODY 和HTML結(jié)束標(biāo)記。即一個最小的尾部HTML至少是這樣</BODY></HTML>。同理，如果你要指定了 HTML_HEADER，他至少包含<HTML><HEAD></HEAD><BODY>。
6 如何在chm文件的索引下顯示函數(shù)列表？
打開[Expert...]的HTML頁面，然后選中TOC_EXPAND即可。
7 如何在chm文件的函數(shù)說明中屏蔽源碼的信息和鏈接？
打開[Expert...]的Source Browser頁面，然后將”SOURCE_BROWSER”選項的鉤去掉。

全部資料51hei下載地址：

ID:276663 · 發(fā)表于 2018-12-27 13:45

謝謝分享，之前也對這東西了解了一下，可能是因為項目工作量不大，都沒具體生成過，只是按照格式寫代碼。確實是一個好用的工具。

帳號		自動登錄	找回密碼
密碼			立即注冊

久久久久久久999_99精品久久精品一区二区爱城_成人欧美一区二区三区在线播放_国产精品日本一区二区不卡视频_国产午夜视频_欧美精品在线观看免费

初用Doxygen自動生成代碼說明文件與常見問題小結(jié)