2015-09-18 26 views
0

我有一個很大的代碼庫,我想用Doxygen做一個第一遍文檔,但它沒有所需的///註釋格式 - 它們都是//。是否有包含所有評論的設置?我過去使用過Doxygen,並明白爲什麼你會希望這兩種格式,所以請不要教育差異:)。問題在這之前被問 - // comments in doxygen - 但沒有回答。設置爲包含//在Doxygen中?

+0

我不認爲有解決方案。 「//」和「///」(或「//!」及其他)之間有區別,所以沒有理由讓該功能甚至存在。對我來說,感覺和編譯器選項一樣,例如,甚至在評論中尋找變量定義。 – Zereges

回答

2

有兩件事情可以做:

首先,讓Doxygen的產生哪些文件會自動就可以了,從剛代碼結構,即使用EXTRACT_ALL = TRUE或兩者HIDE_UNDOC_CLASSES = FALSEHIDE_UNDOC_MEMBERS = FALSE

然後,Doxygen支持預處理器。也許你可以寫一個過濾器,而不是自動更改/*/**/////?根據你的代碼,愚蠢的過濾器可能會或可能不會破壞(例如,這些組合是否出現在字符串文字中?)

最後,Doxygen代碼不難被破解。您應該能夠將///*作爲文檔很容易地識別出來。