您应该对字段变量，属性和放大器使用XML注释吗？构造函数？

Question

到目前为止，我理解XML的优良做法是对类方法进行注释，但是对于应该使用XML注释的程度有一个标准吗？

我是否应该使用它们来记录字段变量，属性和＆amp;建设者还是只是矫枉过正？

看一下网络，但看不出任何严格的规则。

Answer 1

使用与简单英语相对的XML注释有两个原因：

1. 如果评论遵循正确的格式，它们将显示在IntelliSense中，这意味着当我使用您的课程时，我可以看到int a应该是计数或我看到有用信息的相同方式当我使用.NET方法时，

2. 如果您使用Microsoft支持的XML格式，您可以使用SandCastle或类似的第三方实用程序创建html（或其他格式的）文档。

所以，如果你花时间写评论，你也可以把它们作为VS鼓励的XML。