How to suppress a StyleCop warning?

后端 未结 12 1384
心在旅途
心在旅途 2020-11-27 18:23

I\'m using StyleCop and want to suppress some warning which does not suit my style. I prefer to have solution for

1) in-line code suppressing
2) global setting

12条回答
  •  青春惊慌失措
    2020-11-27 18:45

    An example of inline suppression would be similar to this - examine the namespaces in the code compared to the suppression

    namespace Soapi
    {
            ///
            ///
            ///
            ///
            ///
            [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Globalization", "CA1305:SpecifyIFormatProvider", MessageId = "System.String.Format(System.String,System.Object,System.Object)")]
            public ApiException(string message, ErrorCode statusCode, Exception innerException)
                : base(String.Format("{0}\r\nStatusCode:{1}", message, statusCode), innerException)
            {
                this.statusCode = statusCode;
            }
    

    A global supression file is a file in the root of your project named GlobalSuppressions.cs and might look like this:

    // This file is used by Code Analysis to maintain SuppressMessage 
    // attributes that are applied to this project. 
    // Project-level suppressions either have no target or are given 
    // a specific target and scoped to a namespace, type, member, etc. 
    //
    // To add a suppression to this file, right-click the message in the 
    // Error List, point to "Suppress Message(s)", and click 
    // "In Project Suppression File". 
    // You do not need to add suppressions to this file manually. 
    
    [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Globalization", "CA1305:SpecifyIFormatProvider", MessageId = "System.String.Format(System.String,System.Object,System.Object,System.Object)", Scope = "member", Target = "Soapi.ApiException.#.ctor(System.String,Soapi.ErrorCode,System.String,System.Exception)")]
    

    And you can generate this code automatically by right-clicking on the warning.

提交回复
热议问题