前端之家收集整理的这篇文章主要介绍了
什么是用XML文档记录C#代码的最佳实践？，
前端之家小编觉得挺不错的，现在分享给大家，也给大家做个参考。
我将通过一些新的
代码，我刚才写和
添加NDoc sytle
评论我的类和
方法。我希望
生成一个很好的MSDN样式文档供参考。
一般来说，在为类和方法编写注释时有什么好的指南？ NDoc评论应该说什么？他们不应该说什么？
我发现自己看看.NET框架评论说什么，但是变得老快;如果我能有一些好的规则来指导自己，我可以完成我的文档更快。
在用于构建API文档的注释中，您应该：
>解释什么是方法或属性，为什么它存在，并解释任何领域的概念，对于代码的普通消费者不是不言而喻的。>列出参数的所有前提条件(不能为null，必须在一定范围内等)>列出可能影响调用者如何处理返回值的任何后置条件。>列出方法可能抛出的任何异常(以及在什么情况下)。>如果存在类似的方法，请解释它们之间的差异。>调用注意任何意外事件(例如修改全局状态)。>枚举任何副作用，如果有任何。
