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

Question

我发现C#或VB.NET的xml doc注释很难阅读.有没有一个像样的替代方案(仍然提供记录智能感知,文档生成等代码的好处)？

Answer 1

如果可读性是您要解决的问题（即，阅读 XML 会让您眼花缭乱，我也是如此），您可以向 xml 注释文件添加一个样式表。我从这篇旧文章中引用的内容开始，并从那里进行了修改。每次构建时都必须将其添加回来，但是当您记录更改以供以后参考时（即在主动开发期间不大量使用文档），那么这还不算太糟糕。

我还使用GhostDoc来减少文档编写的时间。