跳到主要內容

試用Doxygen

其實我有用Doxygen產生過C++的說明文件,但用在C#是頭一遭。
感謝scarfman的大力推薦,照著簡介Doxygen就可以做出html及rtf格式的說明檔,再參考利用doxygen產生程式說明文件,就有chm格式。由於我沒裝Latex及Ghostscript,因此並沒有製作出pdf格式,不過我並不需要pdf :P
Doxygen速度非常快,使用上(對我)沒什麼問題,從下載到做出文件不到20分鐘就搞定。不過若把OUTPUT_LANGUAGE設定成Chinese-Traditional時,chm左邊的目錄會亂碼,因此還是用English。

平心而論,DoxygenSandCastle是不同定位的工具;SandCastle專注在.Net/MSDN,而且是動態解譯產生說明,可以針對每個method/property選擇是否產生文件。而Doxygen是多語言支援的說明文件產生器,支援多種注解格式。

因此,對敝公司不厲害的工程師來說,要他們對一個個Doxygen設定檔去改實在不可能,還是推DocProject吧!

留言

鮪魚寫道…
這需要修改一下doxygen的設定,左邊的那個目錄就不會是亂碼了。

這個網誌中的熱門文章

自然人憑證讀卡機驅動程式

鳥毅用的是第一代的自然人憑證讀卡機,EZ100PU(後來有同事買EZmini可以讀SIM卡似乎更好),每年報稅時用一次。

本來只是要申請些政府業務,一時之間找不到光碟,沒想到在驅動程式下載居然看到Linux和Mac的驅動程式,剩下的就是政府單位的網頁和程式應該改版了吧!!!

在Windows Server設定L2TP over IPSec VPN

簡單地說,macOS Sierra與iOS 10發表後,大家忽然發現Apple不再支援PPTP,所以一定得設定其他的VPN型態。若不要另外裝client,用L2TP是最方便的,SSL VPN雖然好,但若沒有安裝Agent要連線到任一電腦或是非網頁服務還是挺麻煩的。