在C＃中doxygen样式文档注释是否过高？

Question

我有一个项目，我记录（在源代码中）基本上是一个想法。这不是一个大项目，只有我使用它（我知道）所以这不是什么大不了的事。我使用Doxygen做到了，因为我希望我的所有文档都能够导出为HTML。我的问题是我使用Doxygen样式注释，而不是标准的XML样式注释（我不喜欢，但无论如何）。

现在我正在尝试销售此代码，在我尝试之前，我想确保它的质量很好。我在Doxygen风格评论中看到的问题是他们没有获得intellisense支持。除此之外，C＃中的非XML注释是否过高？是否有任何选项可以在Visual Studio中设置以获得Intellisense支持？

Answer 1

如果你想要智能感知，那么你必须使用XML注释。 Visual C＃编译器无法识别或理解Doxygen。

如果您想使用XML注释生成HTML文档，请使用Sandcastle - 这就是它的用途。

Answer 2

查看我的文档插件AtomineerUtils。

它可以读取Doxygen注释并将它们转换为XML文档格式。它将在一次通过中处理整个范围块，因此可用于将旧文档快速转换为其他格式。

它也是非常可配置的，因此您可以调整输出以使其尽可能可读。