我正在研究我刚刚编写的一些新代码，并将 NDoc 风格注释添加到我的类和方法中。我希望生成一个非常好的 MSDN 样式文档以供引用。
一般来说，在为类和方法编写注释时有哪些好的指导方针？ NDoc 评论应该怎么说？他们不应该说什么？
我发现自己在看 .NET Framework 评论说的内容，但很快就过时了；如果我能有一些好的规则来指导自己，我就能更快地完成我的文档。
最佳答案
在用于构建 API 文档的注释中，您应该:
解释该方法或属性的作用、它存在的原因，并解释任何对您的代码的普通使用者来说不言自明的领域概念。
列出你参数的所有前置条件(不能为空，必须在一定范围内等)
列出任何可能影响调用者处理返回值的方式的后置条件。
列出该方法可能抛出的任何异常(以及在什么情况下)。
如果存在类似的方法，说明它们之间的区别。
提请注意任何意外情况(例如修改全局状态)。
列举任何副作用，如果有的话。
关于c# - 使用 XML 注释记录 C# 代码的最佳实践是什么？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/3143324/