SuppressMessageAttribute(String, String) Constructor

Reference

Definition

Namespace:: System.Diagnostics.CodeAnalysis

Assemblies:: mscorlib.dll, System.Diagnostics.Tools.dll

Assemblies:: netstandard.dll, System.Runtime.dll

Assembly:: System.Diagnostics.Tools.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: SuppressMessageAttribute.cs

Source:: SuppressMessageAttribute.cs

Source:: SuppressMessageAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Initializes a new instance of the SuppressMessageAttribute class, specifying the category of the code analysis tool and the identifier for an analysis rule.

public:
 SuppressMessageAttribute(System::String ^ category, System::String ^ checkId);

public SuppressMessageAttribute(string category, string checkId);

new System.Diagnostics.CodeAnalysis.SuppressMessageAttribute : string * string -> System.Diagnostics.CodeAnalysis.SuppressMessageAttribute

Public Sub New (category As String, checkId As String)

Parameters

category: String

The category for the attribute.

checkId: String

The identifier of the analysis tool rule the attribute applies to.

Examples

The following code example shows the use of the SuppressMessageAttribute attribute to suppress warnings for the Microsoft.Performance category and the CA1801 and CA1804 check identifiers. This code example is part of a larger example provided for the SuppressMessageAttribute class.

[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;
}

<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

Remarks

The category parameter value is specific to the analysis tool and categorizes the rule identified by the checkId parameter. The two parameters concatenated together form a unique identifier for the rule.

Бележка

The preprocessor symbol "CODE_ANALYSIS" must be defined for this attribute to be effective. The absence of the preprocessor symbol results in the attribute not being applied.

Applies to

Продукт	Версии
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP	10.0

Споделяне чрез