SuppressMessageAttribute Classe

Définition

Espace de noms:

System.Diagnostics.CodeAnalysis

Assembly:

System.Runtime.dll

Source:

SuppressMessageAttribute.cs

Supprime le signalement d’une violation de règle d’analyse de code spécifique, autorisant plusieurs suppressions sur un seul artefact de code. Ne s’applique pas aux diagnostics du compilateur.

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

Héritage

Object

Attribute

SuppressMessageAttribute

Attributs

AttributeUsageAttribute ConditionalAttribute

Exemples

L’exemple de code suivant montre l’utilisation de l’attribut SuppressMessageAttribute pour supprimer les messages d’avertissement de performances.

#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

Remarques

Cet attribut peut être appliqué à n’importe quel élément d’application. Pour obtenir la liste complète des violations qui peuvent être supprimées, consultez Règles de qualité du code.

Notes

le ConditionalAttribute est appliqué à cette classe, en spécifiant le symbole de prétraitement « CODE_ANALYSIS » comme symbole conditionnel qui détermine si l’appel d’attribut est inclus ou omis. Si le symbole est défini, l’appel d’attribut est inclus ; sinon, l’appel est omis.

Lorsque vous cliquez avec le bouton droit sur un avertissement d’analyse de code dans Visual Studio et choisissez Supprimer l’ID <>> de règle dans le fichier de suppression ou Supprimer l’ID <>> de règle dans la source (attribut), un attribut SuppressMessage est ajouté au fichier de suppressions globales ou au fichier de code source. Pour plus d’informations sur l’attribut SuppressMessage et son utilisation dans Visual Studio, consultez Supprimer les violations d’analyse de code.

Constructeurs

SuppressMessageAttribute(String, String)

Initialise une nouvelle instance de la SuppressMessageAttribute classe, en spécifiant la catégorie de l’outil d’analyse du code et l’identificateur d’une règle d’analyse.

Propriétés

Category	Obtient la catégorie qui identifie la classification de l'attribut.
CheckId	Obtient l’identificateur de la règle de l’outil d’analyse du code à supprimer.
Justification	Obtient ou définit la justification pour supprimer le message d'analyse du code.
MessageId	Obtient ou définit les critères d’exclusion développés.
Scope	Obtient ou définit la portée du code concernant l'attribut.
Target	Obtient ou définit un chemin d’accès complet qui représente la cible d’analyse du code.
TypeId	Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute. (Hérité de Attribute)

Méthodes

Equals(Object)	Retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
GetHashCode()	Retourne le code de hachage de cette instance. (Hérité de Attribute)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IsDefaultAttribute()	En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée. (Hérité de Attribute)
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)