C＃中的doxygen樣式文檔註釋禁止嗎？

我有一個項目，我記錄（在源代碼中）基本上是一個後來的想法。這不是一個大項目，只有我使用它（我知道），所以這不是什麼大問題。我是用Doxygen做的，因爲我希望我所有的文檔能夠被導出到HTML中。我的問題是我用Doxygen風格的評論，而不是標準的XML風格的評論（我不喜歡，但無論如何）。C＃中的doxygen樣式文檔註釋禁止嗎？

現在我正在試圖出售此代碼，並在嘗試之前，我想確保它的質量很好。我在Doxygen風格的評論中看到的問題是他們沒有獲得智能支持。除此之外，C＃中的非XML註釋是否被禁止？是否有任何選項可以在Visual Studio中設置以獲得Intellisense支持？

來源

2011-04-07 Earlz

如果你想要intellisense，那麼你必須使用XML註釋。 Visual C＃編譯器不識別或理解Doxygen。

如果您想使用XML註釋來生成HTML文檔，請使用Sandcastle - 這就是它的用途。

來源

2011-04-07 01:35:32

但Sandcastle是如此醜陋：/。但Doxygen顯然支持XML評論，所以我只需要轉換我所有的源文檔，我想 – Earlz 2011-04-07 01:40:02

嗯...我認爲Doxygen是醜陋的。你確定你把它設置正確嗎？（它帶有幾個主題和開箱即用）不同人的筆畫我猜。 – 2011-04-07 01:40:50

我見過多個例子，包括微軟自己的源代碼文檔，我發現它的結構非常密集，但很難找到我需要的任何東西......並且是，也很難看。 – Earlz 2011-04-07 22:24:31

查看我的文檔插件，AtomineerUtils。

它可以讀取Doxygen註釋並將它們轉換爲XML文檔格式。它將一次處理整個作用域塊，因此可用於將舊版文檔快速轉換爲其他格式。

它也是非常可配置的，所以你可以調整輸出使其儘可能可讀。

來源

2011-04-08 06:40:44

我沒有太多的代碼可以轉換，所以我只花了一兩個小時，一次完成。如果我正在研究一個更大的項目，我肯定會覺得這很有用 – Earlz 2011-04-08 23:22:07

C＃中的doxygen樣式文檔註釋禁止嗎？

回答

相關問題