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

你的一些參數有一個單詞作爲文檔，這顯然是不夠的（至少需要10個字符+至少需要一個空格）。

• Sender
• Authority

寫什麼是這些參數的目的有用的描述。

此外，對於事件處理，你真的應該採取文檔文本Microsoft使用：

/// <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()方法文檔使用多個詞來描述其參數。更具描述性，您將避免違反此規則。