2012-02-07 53 views
2

我有一個c#項目,我需要使用doxygen進行文檔化。它收集由視覺工作室的///自動生成的評論,但不幸的是它沒有選擇正常的//評論。有沒有配置設置,我錯過了?或者這是不可能的?// doxygen中的註釋

回答

6

///被稱爲XML Documentation Comments。這就是Doxygen和其他文檔生成軟件如何找到想將用作文檔的代碼區域。

詳細說明一下,如果您的代碼中有類似// This is hacky, but I'll return to it later的評論,您應該將其更改爲有關方法,屬性或對象的XML註釋部分。

+0

好吧,這是有道理的。 – Tim 2012-02-07 13:23:06

2

對我來說,這不是一個錯誤,而是一個功能。有些評論我確實希望在代碼中留下,而不是提取並顯示每個人。 ///和//之間的區別允許我這樣做。

相關問題