Doxygen 介紹和下載,安裝
簡介
Doxygen是一個程序的文檔產生工具,可以將程序中的注釋轉換成說明文檔或者說是API參考手冊,從而減少程序員整理文檔的時間。當然這里程序中的注釋需要遵循一定的規則書寫,才能讓Doxygen識別和轉化。
目前Doxygen可處理的程序語言包含C/C++、Java、Objective-C、IDL等,可產生出來的文檔格式有HTML、XML、LaTeX、RTF等,此外還可衍生出不少其它格式;
如?HTML可以打包成CHM格式,而LaTeX可以通過一些工具產生出PS或是PDF文檔等。
如?可以利用Doxygen給C,C++程序生成注釋文檔
Doxygen安裝及使用
1)推薦版本--安裝列表:(windows)
Doxygen: -,http://doxygen.nl/files/doxygen-1.8.15-setup.exe
HTML Help:微軟官方用于生成HTML格式的help文件,-,http://go.microsoft.com/fwlink/p/?linkid=14188
Graphviz:一種dot工具可以用來渲染出效果更好的圖表,-,https://graphviz.gitlab.io/_pages/Download/Download_windows.html
windows上安裝很簡單,無需特別設置。
2)其他版本:(根據系統選擇)
Doxygen可以從一套源文件開始,生成HTML格式的在線類瀏覽器。建議采用的版本是Doxygen1.8.16(目前最新,以后會替換)
Microsoft HTML Help Workshop是微軟開發,用于本工程創建*.chm文件,建議上官網下載最新的htmlhelp
Graphviz用于配合doxygen使用,提取函數之間、頭文件之間的調用關系,建議上官網下載最新的graphviz
說明:
下載Doxygen + Graphviz
Doxygen可以生成動態文檔
Graphviz可以生成視圖連接將.c文件中所用到的函數、頭文件生成一個樹狀結構并且設置之后可以生成相對應的函數的跳轉,方便查詢函數。
安裝步驟
1)安裝 ?graphviz?(dot, 結構圖關系圖用到)
2)安裝Windows?Help?Workshop(生成 .chm用到)
3)安裝doxygen
例如:安裝Windows?Help?Workshop
安裝完成后,打開Doxygen
打開如下界面:
恭喜你成功安裝Doxygen
希望對你有幫助。
HTML
版權聲明:本文內容由網絡用戶投稿,版權歸原作者所有,本站不擁有其著作權,亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容,請聯系我們jiasou666@gmail.com 處理,核實后本網站將在24小時內刪除侵權內容。