星期二, 2月 19, 2008

試用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吧!

1 則留言:

鮪魚 提到...

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