SuppressMessageAttribute Klasse

Definition

Namespace:

System.Diagnostics.CodeAnalysis

Assembly:

System.Runtime.dll

Quelle:

SuppressMessageAttribute.cs

Unterdrückt die Meldung eines bestimmten Codeanalyseregel-Verstoßes und lässt mehrere Unterdrückungen in einem einzelnen Codeartefakt zu. Dies gilt nicht für die Compilerdiagnose.

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

Vererbung

Object

Attribute

SuppressMessageAttribute

Attribute

AttributeUsageAttribute ConditionalAttribute

Beispiele

Das folgende Codebeispiel zeigt die Verwendung des Attributs SuppressMessageAttribute , um Leistungswarnungen zu unterdrücken.

#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

Hinweise

Dieses Attribut kann auf jedes Anwendungselement angewendet werden. Eine vollständige Liste der Verstöße, die unterdrückt werden können, finden Sie unter Codequalitätsregeln.

Hinweis

Wird ConditionalAttribute auf diese Klasse angewendet und gibt das Vorverarbeitungssymbol "CODE_ANALYSIS" als bedingungsbedingtes Symbol an, das bestimmt, ob der Attributaufruf eingeschlossen oder nicht angegeben wird. Wenn das Symbol definiert ist, ist der Attributaufruf enthalten. andernfalls wird der Aufruf ausgelassen.

Wenn Sie in Visual Studio mit der rechten Maustaste auf eine Codeanalysewarnung klicken und in der Unterdrückungsdatei Regel-ID>> unterdrücken < oder <Regel-ID>> unterdrücken in Quelle (Attribut) auswählen, wird entweder der globalen Unterdrückungsdatei oder der Quellcodedatei ein SuppressMessage-Attribut hinzugefügt. Weitere Informationen zum SuppressMessage-Attribut und seiner Verwendung in Visual Studio finden Sie unter Unterdrücken von Codeanalyseverletzungen.

Konstruktoren

SuppressMessageAttribute(String, String)

Initialisiert eine neue Instanz der SuppressMessageAttribute-Klasse und gibt die Kategorie des Codeanalysetools und den Bezeichner für eine Analyseregel an.

Eigenschaften

Category	Ruft die Kategorie ab, die die Klassifizierung des Attributs bezeichnet.
CheckId	Ruft den Bezeichner der Codeanalysetool-Regel ab, die unterdrückt werden soll.
Justification	Ruft die Begründung für das Unterdrücken der Codeanalysemeldung ab oder legt diese fest.
MessageId	Ruft die erweiterten Ausschlusskriterien ab oder legt sie fest.
Scope	Ruft den Bereich des Codes ab, der für das Attribut relevant ist, oder legt diesen fest.
Target	Ruft einen voll qualifizierten Pfad ab, der das Codeanalyseziel darstellt, oder legt ihn fest.
TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab. (Geerbt von Attribute)

Methoden

Equals(Object)	Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist. (Geerbt von Attribute)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von Attribute)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist. (Geerbt von Attribute)
Match(Object)	Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht. (Geerbt von Attribute)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)