為什么類屬性需要注釋

Question

StyleCop使用它對規則SA1623強制執行的Gets or Sets ...表示法

我的問題是，為什么，從我可以看到的絕大多數時間它是自我解釋的，並需要大量的重復才能擁有這些？

/// <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; }
}

對這些屬性的評論確實沒有增加任何價值，因為它們非常具有自我描述性

我非常喜歡在項目中使用StyleCop。 但這並不意味着你必須采取它附帶的每一條規則。 禁用那些對您的項目沒有意義的項目並接受那些項目

Answer 2

為了公開訪問成員的文檔的完整性？

Answer 3

沒有必要。 從我的觀點來看，它就像你說的那樣不言自明。

如果變量具有有用的名稱，那么編寫類似的東西是浪費時間。

如果有變量，這些變量不是不言自明的，那么這些注釋會很有用（例如一些舊代碼？）

Answer 4

由於我的工作代碼標准，我有義務撰寫這些類型的評論。 對我來說，當它的名字顯示其目的時，沒有必要在屬性中添加注釋。

這種方法的主要問題是浪費時間評論以及評論本身無益的事實。 大部分時間它只是重復屬性的名稱。

PS：我的觀點僅適用於屬性名稱顯示其用途的情況。 有幾種情況強烈建議進行評論。