StyleCop SA1630

Question

Quelle différence entre ces méthodes, pourquoi SortDropDown est correct mais Page_load et GetCases ne le sont pas?

Je ne comprends pas.
Et comment résoudre ce problème?

Modifier ne peux pas bien voir sur la photo

code:

 /// <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) 
     { 

     } 

Merci!

Answer 1

Certains de vos paramètres ont un seul mot comme documentation, ce qui n'est évidemment pas suffisant (il faut au moins 10 caractères + au moins un espace).

• Sender
• Authority

Ecrire une description utile sur ce qui est le but de ces paramètres.

En outre, pour les gestionnaires d'événements, vous devriez vraiment adopter le texte de la documentation utilisée par 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

La différence est que la documentation utilise un mot pour décrire l'un des paramètres de l'événement Page_Load() et GetCases() méthode , alors que la documentation de la méthode SortDropDown() utilise plus d'un mot pour décrire son paramètre. Soyez plus descriptif et vous éviterez cette violation de règle.