C# 使用两者的目的<；价值>；及<；总结>；VisualStudioXML文档中的标记

我在VS 2012中使用C#，将XML文档添加到我的代码中，我意外地打开了一个StyleCop规则（特别是SA1609），该规则“验证公共或受保护属性是否包含带有值标记的文档头”

还有另一条规则（SA1604，这次故意打开），它“验证文档头是否包含格式正确的摘要标记”

但是，我很难看到您在值标记中放了什么，而这个值标记还没有放在摘要标记中。目前，我的摘要标签的意思是“获取或设置某些内容”。应该在相应的值标记中添加什么来补充它

（为了澄清，我很高兴设置StyleCop——当我意外地打开所有文档规则时，它让我注意到了值标记）

MSDN在这方面没有太大帮助：

• 似乎意味着您应该详细说明使用了什么支持字段（无论如何，从信息隐藏的角度来看，这似乎是个坏主意）
• 表示“值标记用于描述属性值”。我甚至不知道这意味着什么——对我来说，这听起来很像一个总结

tl；博士

---

在属性的XML文档中同时使用摘要和值标记有什么意义？如何在不重复自己的情况下使用它们？

很简单：这使得随着代码的发展更容易使它们保持最新

---

我个人认为，当代码必须由其他作者修改时，它会添加一些更有用的信息。

摘要是对属性可以做什么做一个总体概述，而值只描述了这一点，即属性的期望值

以下是MSDN差异的一个很好的例子：

摘要：获取一个值，该值指示IList是否具有固定大小。

值：如果IList具有固定大小，则为true；否则，错误。在列表的默认实现中，此属性始终返回false

---

在大多数情况下，摘要标记通常会声明“获取或设置一个值…”，而值标记通常会声明期望的值，包括期望的默认值。

Heh这样解释似乎很明显。换句话说，它类似于方法上使用的

标记。如何使它们更容易保持最新？