SuppressMessageAttribute Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Supprime la création de rapports d’une violation de règle d’analyse de code spécifique, ce qui permet 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
- Attributs
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 les règles de qualité du code.
Note
Il 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 du code dans Visual Studio et choisissez
Constructeurs
| Nom | Description |
|---|---|
| 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
| Nom | Description |
|---|---|
| Category |
Obtient la catégorie identifiant 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 de la suppression du message d’analyse du code. |
| MessageId |
Obtient ou définit les critères d’exclusion développés. |
| Scope |
Obtient ou définit l’étendue du code pertinent pour l’attribut. |
| Target |
Obtient ou définit un chemin complet qui représente la cible d’analyse du code. |
| TypeId |
En cas d’implémentation dans une classe dérivée, obtient un identificateur unique pour cette Attribute. (Hérité de Attribute) |
Méthodes
| Nom | Description |
|---|---|
| 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 pour cette instance. (Hérité de Attribute) |
| GetType() |
Obtient la 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 de la classe dérivée. (Hérité de Attribute) |
| Match(Object) |
En cas de substitution dans une classe dérivée, retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute) |
| MemberwiseClone() |
Crée une copie superficielle du Objectactuel. (Hérité de Object) |
| ToString() |
Retourne une chaîne qui représente l’objet actuel. (Hérité de Object) |
Implémentations d’interfaces explicites
| Nom | Description |
|---|---|
| _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) |
Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch. (Hérité de Attribute) |
| _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) |
Récupère les informations de type d’un objet, qui peuvent être utilisées pour obtenir les informations de type d’une interface. (Hérité de Attribute) |
| _Attribute.GetTypeInfoCount(UInt32) |
Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1). (Hérité de Attribute) |
| _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) |
Fournit l’accès aux propriétés et méthodes exposées par un objet. (Hérité de Attribute) |