SuppressMessageAttribute Clase

Definición

Espacio de nombres:

System.Diagnostics.CodeAnalysis

Ensamblado:

mscorlib.dll

Suprime los informes de una infracción de regla de análisis de código específica, lo que permite varias supresiones en un único artefacto de código. No se aplica a los diagnósticos del compilador.

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

Herencia

Object

Attribute

SuppressMessageAttribute

Atributos

AttributeUsageAttribute ConditionalAttribute

Ejemplos

En el ejemplo de código siguiente se muestra el uso del SuppressMessageAttribute atributo para suprimir los mensajes de advertencia de rendimiento.

#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

Comentarios

Este atributo se puede aplicar a cualquier elemento de aplicación. Para obtener una lista completa de las infracciones que se pueden suprimir, consulte Reglas de calidad de código.

Note

ConditionalAttribute se aplica a esta clase, especificando el símbolo de preprocesamiento "CODE_ANALYSIS" como símbolo condicional que determina si la llamada de atributo se incluye o se omite. Si se define el símbolo, se incluye la llamada de atributo; de lo contrario, se omite la llamada.

Al hacer clic con el botón derecho en una advertencia de análisis de código en Visual Studio y elegir Suppress <rule-ID>> en Archivo de supresión o Suppress <rule-ID>> en Source (attribute), un atributo SuppressMessage se agrega al archivo de supresiones globales o al archivo de código fuente. Para obtener más información sobre el atributo SuppressMessage y su uso en Visual Studio, vea Suppress infracciones de análisis de código.

Constructores

Nombre	Description
SuppressMessageAttribute(String, String)	Inicializa una nueva instancia de la SuppressMessageAttribute clase , especificando la categoría de la herramienta de análisis de código y el identificador de una regla de análisis.

Propiedades

Nombre	Description
Category	Obtiene la categoría que identifica la clasificación del atributo.
CheckId	Obtiene el identificador de la regla de herramientas de análisis de código que se va a suprimir.
Justification	Obtiene o establece la justificación para suprimir el mensaje de análisis de código.
MessageId	Obtiene o establece los criterios de exclusión expandidos.
Scope	Obtiene o establece el ámbito del código que es relevante para el atributo .
Target	Obtiene o establece una ruta de acceso completa que representa el destino de análisis de código.
TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute)

Métodos

Nombre	Description
Equals(Object)	Devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
GetHashCode()	Devuelve el código hash de esta instancia. (Heredado de Attribute)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsDefaultAttribute()	Cuando se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada. (Heredado de Attribute)
Match(Object)	Cuando se reemplaza en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
MemberwiseClone()	Crea una copia superficial del Objectactual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Implementaciones de interfaz explícitas

Nombre	Description
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío. (Heredado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Recupera la información de tipo de un objeto, que se puede usar para obtener la información de tipo de una interfaz. (Heredado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1). (Heredado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Proporciona acceso a propiedades y métodos expuestos por un objeto . (Heredado de Attribute)