c# - 您应该在字段变量、属性和构造函数上使用 XML 注释吗？

Question

到目前为止，我知道对类方法进行 XML 注释是一种很好的做法，但是对于您应该使用多少 XML 注释有一个标准吗？

我应该使用它们来记录字段变量、属性和构造函数还是只是矫枉过正？

浏览了网络，但看不到此类事情的任何硬性规定。

Answer 1

使用 XML 注释而不是简单的英语有两个原因：

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

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

因此，如果您花时间写评论，您不妨将它们设为 VS 鼓励的 XML 评论。