Suppresses reporting of a specific code analysis rule violation, allowing multiple suppressions on a single code artifact. Does not apply to compiler diagnostics.
public ref class SuppressMessageAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=true, Inherited=false)]
[System.Diagnostics.Conditional("CODE_ANALYSIS")]
public sealed class SuppressMessageAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.All, AllowMultiple=true, Inherited=false)>]
[<System.Diagnostics.Conditional("CODE_ANALYSIS")>]
type SuppressMessageAttribute = class
inherit Attribute
Public NotInheritable Class SuppressMessageAttribute
Inherits Attribute
The following code example shows the use of the SuppressMessageAttribute attribute to suppress performance warning messages.
#define CODE_ANALYSIS
using System;
using System.Diagnostics.CodeAnalysis;
namespace CodeAnalysisSample
{
class Library
{
[SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId = "isChecked")]
[SuppressMessage("Microsoft.Performance", "CA1804:RemoveUnusedLocals", MessageId = "fileIdentifier")]
static void FileNode(string name, bool isChecked)
{
string fileIdentifier = name;
string fileName = name;
string version = String.Empty;
}
}
}
#Const CODE_ANALYSIS = True
Imports System.Diagnostics.CodeAnalysis
Class Library
<SuppressMessage("Microsoft.Performance", "CA1801:ReviewUnusedParameters", MessageId:="isChecked"), _
SuppressMessage("Microsoft.Performance", "CA1804:RemoveUnusedLocals", MessageId:="fileIdentifier")> _
Shared Sub FileNode(ByVal name As String, ByVal isChecked As Boolean)
Dim fileIdentifier As String = name
Dim fileName As String = name
Dim version As String = String.Empty
End Sub
End Class
This attribute can be applied to any application element. For a complete list of the violations that can be suppressed, see Code quality rules.
Note
The ConditionalAttribute is applied to this class, specifying the preprocessing symbol "CODE_ANALYSIS" as the conditional symbol that determines whether the attribute call is included or omitted. If the symbol is defined, the attribute call is included; otherwise, the call is omitted.
When you right-click a code analysis warning in Visual Studio and choose Suppress <rule-ID> > in Suppression File or Suppress <rule-ID> > in Source (attribute), a SuppressMessage attribute is added to either the global suppressions file or to the source code file. For more information about the SuppressMessage attribute and its use in Visual Studio, see Suppress code analysis violations.
Constructors Properties CategoryGets the category identifying the classification of the attribute.
CheckIdGets the identifier of the code analysis tool rule to be suppressed.
JustificationGets or sets the justification for suppressing the code analysis message.
MessageIdGets or sets the expanded exclusion criteria.
ScopeGets or sets the scope of the code that is relevant for the attribute.
TargetGets or sets a fully qualified path that represents the code analysis target.
TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute) Methods Explicit Interface Implementations _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)Maps a set of names to a corresponding set of dispatch identifiers.
(Inherited from Attribute) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)Retrieves the type information for an object, which can be used to get the type information for an interface.
(Inherited from Attribute) _Attribute.GetTypeInfoCount(UInt32)Retrieves the number of type information interfaces that an object provides (either 0 or 1).
(Inherited from Attribute) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)Provides access to properties and methods exposed by an object.
(Inherited from Attribute)RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4