Come sopprimere StyleCop Warning SA1649

Question

Sto tentando di sopprimere due occorrenze dell'errore SA1649 in StyleCop.

Secondo il documentation l'attributo di soppressione si presenta come l'attributo di sotto

[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1649:FileHeaderFileNameDocumentationMustMatchTypeName", Justification = "Reviewed.")] 

Tuttavia, non riesco a capire quale elemento dovrei applicare l'attributo a. Se metto l'attributo sul primo elemento del file (l'interfaccia IClassFactory), ottengo il seguente errore:

SA1649 : CSharp.Documentation : The file attribute in the file header's copyright tag must contain the name of the first type in the file and can be any of these: "IClassFactory" C:(...)COMHelper.cs

Può quell'errore essere soppresso? A quale elemento dovrebbe essere applicato?

Answer 1

Gli attributi di soppressione devono essere inseriti nella dichiarazione della classe o dell'interfaccia. Questo dovrebbe essere fatto in ogni file cs a cui non vuoi applicare questa regola.

Tuttavia, se si desidera sopprimere questo per tutti i file cs nel progetto, è necessario considerare di disabilitare questa regola tutte insieme nelle impostazioni. In questo modo non hai una dichiarazione di regola di soppressione su ogni file di classe.

Answer 2

Utilizzare una soppressione livello di spazio dei nomi:

[module: System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1649:FileHeaderFileNameDocumentationMustMatchTypeName", Justification = "Reviewed.")] 

namespace MyNamespace 
{ 

} 

Answer 3

Chris' opere di risposta, ma per aggiungere ad essa potrebbe essere necessario sopprimere la regola intestazione del file troppo.

[module: System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1649:FileHeaderFileNameDocumentationMustMatchTypeName", Justification = "Reviewed.")] 
[module: System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1633:FileMustHaveHeader", Justification = "Reviewed.")] 

//---------------------------------------------------------------------------------------------------- 
// <copyright file="FileName.cs" company="Company"> 
//  Copyright (c) Company. All rights reserved. 
// </copyright> 
// <author>n00bz</author> 
//---------------------------------------------------------------------------------------------------- 
namespace TestNamespace 
{ 
} 

Answer 4

ancora meglio:

//---------------------------------------------------------------------------------------------------- 
// <copyright file="FileName.cs" company="Company"> 
//  Copyright (c) Company. All rights reserved. 
// </copyright> 
// <author>n00bz</author> 
//---------------------------------------------------------------------------------------------------- 
[module: System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1649:FileHeaderFileNameDocumentationMustMatchTypeName", Justification = "Reviewed.")] 

namespace TestNamespace 
{ 
}