這一次我在谷歌搜索中檢索到了Doxygen在github的倉庫,進去一看,令人大喜,github倉庫里含有了一個Doxygen的官方配置文件Doxyfile,于是下載下來,發現Doxyfile已經配置了將倉庫中的\src文件編譯成Documentation,并且將結果放在了doxygen_docs里面。如下圖所示:
接著我們可以一邊查看源代碼,一邊查看效果HTML,很快就可以熟悉Doxygen操作了。
我這里羅列了一些比較常用的用法。
- 排版?
? ? 關于排版,有兩種格式比較常用,分別如下:
?
以上兩種方式都有出現,不過我個人比較喜歡第二種。
那怎么設置,會出現這兩種不同的效果呢?答案很簡單,在【Output】中選取HTML格式時,若選擇【with navigation panel】,則為第二種效果,否則為第一種效果,如下:
- 在生成的文檔中附加源代碼
如果不勾選以上選項,則在最后生成的文檔中只有.h文件而沒有.cpp等文件。
- 添加源文檔,我們在前面的【Wizard】---->【Project】,已經填寫了源代碼路徑,不過那個路徑只有一個,如果你需要多個,可以在這里添加。
- 添加必要的源代碼路徑,有些文件不會出現在最終的說明文檔中,但對我們要input的文檔是必要的,所以需要添加上相應的路徑。