对于C＃的xml文档注释是否有一个很好的替代方案？

Question

我发现C＃或VB.NET的xml doc注释很难阅读。是否有一个像样的替代方案（仍然提供了记录智能感知，文档生成等代码的好处）？

Answer 1

如果可读性是你试图解决的问题（即读取XML使你的眼睛晃动，它就是我的眼睛），你可以在xml注释文件中添加样式表。我从this old post中引用的那个开始，然后从那里进行了修改。你必须在每次构建时都添加它，但是当你记录你的更改以供以后参考时（即在活动开发期间没有大量使用文档）那么它也不会太糟糕。

我还使用GhostDoc来减少文档耗时。

Answer 2

Visual Studio的Intellisense只读取XML文档。任何其他方法最终都会为您生成，并且会变得过时，除非您保持一致，保持同步。

Answer 3

可以尝试doxygen。除了具有令人耳目一新的名称，它具有更轻的语法。有文档生成工具，它声称支持C＃。

Answer 4

cr_documentor是另一种选择。您使用标准的xml文档（因此intellisnese和其他doc实用程序保持高兴）。人类可读的文档在窗口中呈现（停靠或浮动）。

它可能不完全是您想要的，但您可能会看一下它。