StyleCop SA1630

Question

この方法の違いは、SortDropDownは正しいが、Page_loadとGetCasesは正しくないのはなぜですか？

わかりません。
これを修正するにはどうすればよいですか？

 /// <summary> 
     /// Sort items in drop down list 
     /// </summary> 
     /// <param name="dropDown">Drop down list</param> 
     internal static void SortDropDown(ref DropDownList dropDown) 
     { 

     } 

     /// <summary> 
     /// PageLoad event handler 
     /// </summary> 
     /// <param name="sender">Sender</param> 
     /// <param name="e">Event Args</param> 
     protected void Page_Load(object sender, EventArgs e) 
     { 

     } 

     /// <summary> 
     /// Get all cases by authority and ShopNo 
     /// </summary> 
     /// <param name="authority">Authority</param> 
     /// <param name="shopNo">Shop No</param> 
     /// <returns>Cases list</returns> 
     private static IEnumerable<CaseSummary> GetCases(string authority, string shopNo) 
     { 

     } 

ありがとう：

編集は

コード画像

に良く見かけるカント！

Answer 1

パラメータの中には、ドキュメントとして1つの単語しかありませんが、明らかに十分ではありません（少なくとも10文字+少なくとも空白が必要です）。

• Sender
• Authority

これらのパラメータの目的が何であるかについての有用な説明を書きます。マイクロソフトが使用する

また、イベントハンドラのために、あなたは本当にドキュメントのテキストを採用すべきである：

/// <summary> 
/// Handles the XXXXX event of YYYY. 
/// </summary> 
/// <param name="sender">The source of the event.</param> 
/// <param name="e">The <see cref="EventArgs"/> instance containing the event data.</param> 

Answer 2

違いは、ドキュメントがPage_Load()イベントとGetCases()メソッドのパラメータのいずれかを記述するために一つの単語を使用していることですSortDropDown()メソッドのドキュメントでは、複数の単語を使用してそのパラメータを説明しています。より説明的で、このルール違反を避けることができます。