c# - 为什么类属性需要注释

Question

StyleCop 使用 Gets or Sets ... 符号，它通过规则 SA1623 强制执行。

我的问题是，据我所知，大多数情况下它是不言自明的，需要大量重复才能拥有这些内容，这是为什么？

/// <summary>
/// Gets or sets the name of the customer
/// </summary>
public string Name { get; set; }

/// <summary>
/// Gets or sets whether the record is archived
/// </summary>
public string IsArchive{ get; set; } 

它也可能使它过于冗长，当你只有 10 行时，每一行都声明一个属性，你最终有 30 多行来对每一行进行总结评论!

Answer 1

StyleCop 规则不是绝对的，而是指南。一般来说，这是一个很好的规则，但在某些情况下，是的，属性非常简单，以至于文档可能有点矫枉过正。例如

class Student { 
  public string FirstName { get; set; } 
  public string LastName { get; set; }
}

对这些属性的评论实际上没有任何值(value)，因为它们非常 self 描述。

我非常喜欢在项目中使用 StyleCop。但这并不意味着您必须遵守它附带的每一条规则。禁用那些对你的项目没有意义的，并接受那些对你的项目有意义的