SuppressMessageAttribute Klasa

Definicja

Przestrzeń nazw:

System.Diagnostics.CodeAnalysis

Zestaw:

System.Runtime.dll

Źródło:

SuppressMessageAttribute.cs

Pomija raportowanie określonego naruszenia reguły analizy kodu, co pozwala na wiele pomijania pojedynczego artefaktu kodu. Nie dotyczy diagnostyki kompilatora.

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

Dziedziczenie

Object

Attribute

SuppressMessageAttribute

Atrybuty

AttributeUsageAttribute ConditionalAttribute

Przykłady

Poniższy przykład kodu przedstawia użycie atrybutu do SuppressMessageAttribute pomijania komunikatów ostrzegawczych dotyczących wydajności.

#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

Uwagi

Ten atrybut można zastosować do dowolnego elementu aplikacji. Aby uzyskać pełną listę naruszeń, które można pominąć, zobacz Reguły jakości kodu.

Uwaga

Element ConditionalAttribute jest stosowany do tej klasy, określając symbol wstępnego przetwarzania "CODE_ANALYSIS" jako symbol warunkowy, który określa, czy wywołanie atrybutu jest dołączone, czy pominięte. Jeśli symbol jest zdefiniowany, uwzględniane jest wywołanie atrybutu; w przeciwnym razie wywołanie zostanie pominięte.

Po kliknięciu prawym przyciskiem myszy ostrzeżenia analizy kodu w programie Visual Studio i wybraniu pozycji Pomiń <identyfikator>> reguły w pliku pomijania lub Pomiń <identyfikator>> reguły w źródle (atrybut), atrybut SuppressMessage zostanie dodany do pliku globalnych pomijania lub do pliku kodu źródłowego. Aby uzyskać więcej informacji na temat atrybutu SuppressMessage i jego użycia w programie Visual Studio, zobacz Pomijanie naruszeń analizy kodu.

Konstruktory

SuppressMessageAttribute(String, String)

Inicjuje SuppressMessageAttribute nowe wystąpienie klasy, określając kategorię narzędzia do analizy kodu i identyfikator reguły analizy.

Właściwości

Category	Pobiera kategorię identyfikującą klasyfikację atrybutu.
CheckId	Pobiera identyfikator reguły narzędzia do analizy kodu, która ma zostać pominięta.
Justification	Pobiera lub ustawia uzasadnienie pomijania komunikatu analizy kodu.
MessageId	Pobiera lub ustawia rozszerzone kryteria wykluczania.
Scope	Pobiera lub ustawia zakres kodu, który jest odpowiedni dla atrybutu.
Target	Pobiera lub ustawia w pełni kwalifikowaną ścieżkę, która reprezentuje cel analizy kodu.
TypeId	Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego Attributeelementu . (Odziedziczone po Attribute)

Metody

Equals(Object)	Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi. (Odziedziczone po Attribute)
GetHashCode()	Zwraca wartość skrótu dla tego wystąpienia. (Odziedziczone po Attribute)
GetType()	Type Pobiera wartość bieżącego wystąpienia. (Odziedziczone po Object)
IsDefaultAttribute()	Podczas zastępowania w klasie pochodnej wskazuje, czy wartość tego wystąpienia jest wartością domyślną dla klasy pochodnej. (Odziedziczone po Attribute)
Match(Object)	Po przesłonięciu w klasie pochodnej zwraca wartość wskazującą, czy to wystąpienie jest równe określonemu obiektowi. (Odziedziczone po Attribute)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)