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样式文档注释禁止吗？

回答

相关问题