SuppressMessageAttribute Classe

Definizione

Spazio dei nomi:

System.Diagnostics.CodeAnalysis

Assembly:

System.Runtime.dll

Source:

SuppressMessageAttribute.cs

Elimina la segnalazione di una violazione specifica della regola di analisi del codice, consentendo più eliminazioni su un singolo artefatto di codice. Non si applica alla diagnostica del compilatore.

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

Ereditarietà

Object

Attribute

SuppressMessageAttribute

Attributi

AttributeUsageAttribute ConditionalAttribute

Esempio

Nell'esempio di codice seguente viene illustrato l'uso dell'attributo SuppressMessageAttribute per eliminare i messaggi di avviso delle prestazioni.

#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

Commenti

Questo attributo può essere applicato a qualsiasi elemento dell'applicazione. Per un elenco completo delle violazioni che possono essere eliminate, vedere Regole di qualità del codice.

Nota

L'oggetto ConditionalAttribute viene applicato a questa classe, specificando il simbolo di pre-elaborazione "CODE_ANALYSIS" come simbolo condizionale che determina se la chiamata all'attributo è inclusa o omessa. Se il simbolo è definito, viene inclusa la chiamata all'attributo; in caso contrario, la chiamata viene omessa.

Quando si fa clic con il pulsante destro del mouse su un avviso di analisi del codice in Visual Studio e si sceglie Elimina ID>> regola in File di eliminazione o Elimina <<ID>> regola in Origine (attributo), viene aggiunto un attributo SuppressMessage al file di eliminazione globale o al file del codice sorgente. Per altre informazioni sull'attributo SuppressMessage e sul relativo uso in Visual Studio, vedere Eliminare le violazioni di analisi del codice.

Costruttori

SuppressMessageAttribute(String, String)

Inizializza una nuova istanza della SuppressMessageAttribute classe , specificando la categoria dello strumento di analisi del codice e l'identificatore per una regola di analisi.

Proprietà

Category	Ottiene la categoria che identifica la classificazione dell'attributo.
CheckId	Ottiene l'identificatore della regola dello strumento di analisi del codice da eliminare.
Justification	Ottiene o imposta la giustificazione per impedire la visualizzazione del messaggio di analisi del codice.
MessageId	Ottiene o imposta i criteri di esclusione espansi.
Scope	Ottiene o imposta l'ambito del codice pertinente per l'attributo.
Target	Ottiene o imposta un percorso completo che rappresenta la destinazione di analisi del codice.
TypeId	Quando è implementata in una classe derivata, ottiene un identificatore univoco della classe Attribute. (Ereditato da Attribute)

Metodi

Equals(Object)	Restituisce un valore che indica se questa istanza è uguale a un oggetto specificato. (Ereditato da Attribute)
GetHashCode()	Restituisce il codice hash per l'istanza. (Ereditato da Attribute)
GetType()	Ottiene l'oggetto Type dell'istanza corrente. (Ereditato da Object)
IsDefaultAttribute()	In caso di override in una classe derivata, indica se il valore di questa istanza è il valore predefinito per la classe derivata. (Ereditato da Attribute)
Match(Object)	Quando è sottoposto a override in una classe derivata, restituisce un valore che indica se questa istanza equivale a un oggetto specificato. (Ereditato da Attribute)
MemberwiseClone()	Crea una copia superficiale dell'oggetto Object corrente. (Ereditato da Object)
ToString()	Restituisce una stringa che rappresenta l'oggetto corrente. (Ereditato da Object)