SuppressMessageAttribute SuppressMessageAttribute SuppressMessageAttribute SuppressMessageAttribute Class

Definición

Suprime la elaboración de un informe de la infracción de una regla específica de la herramienta de análisis estático, permitiendo varias supresiones en un solo artefacto de código.Suppresses reporting of a specific static analysis tool rule violation, allowing multiple suppressions on a single code artifact.

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
type SuppressMessageAttribute = class
    inherit Attribute
Public NotInheritable Class SuppressMessageAttribute
Inherits Attribute
Herencia
SuppressMessageAttributeSuppressMessageAttributeSuppressMessageAttributeSuppressMessageAttribute
Atributos

Ejemplos

En el ejemplo de código siguiente se muestra el SuppressMessageAttribute uso del atributo para suprimir los mensajes de advertencia de rendimiento.The following code example shows the use of the SuppressMessageAttribute attribute to suppress performance warning messages.

#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
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 'FileNode
End Class 'Library 

Comentarios

Este atributo se puede aplicar a cualquier elemento de la aplicación.This attribute can be applied to any application element. Para obtener una lista completa de las infracciones que se pueden suprimir, vea análisis de código para advertencias de código administrado.For a complete list of the violations that can be suppressed, see Code Analysis for Managed Code Warnings.

Nota

ConditionalAttribute Se aplica a esta clase, especificando el símbolo de preprocesamiento "CODE_ANALYSIS" como el símbolo condicional que determina si la llamada al atributo se incluye o se omite.The ConditionalAttribute is applied to this class, specifying the preprocessing symbol "CODE_ANALYSIS" as the conditional symbol that determines whether the attribute call is included or omitted. Si se define el símbolo, se incluye la llamada de atributo; de lo contrario, se omite la llamada.If the symbol is defined, the attribute call is included; otherwise, the call is omitted.

Al hacer clic con el botón secundario en una advertencia de análisis de código en el lista de errores de Visual Studio y hacer clic en suprimir mensajes, se agrega un atributo SuppressMessage en el código o en el archivo de supresiones globales del proyecto.When you right-click a Code Analysis warning in the Visual Studio Error List and then click Suppress Message(s), a SuppressMessage attribute is added either in your code or to the project's global suppressions file. Para obtener más información sobre el atributo SuppressMessage y su uso en Visual Studio, vea en información general sobre la supresión de código fuente.For more information about the SuppressMessage attribute and its use in Visual Studio, see In Source Suppression Overview.

Constructores

SuppressMessageAttribute(String, String) SuppressMessageAttribute(String, String) SuppressMessageAttribute(String, String) SuppressMessageAttribute(String, String)

Inicializa una nueva instancia de la clase SuppressMessageAttribute, especificando la categoría de la herramienta de análisis estático y el identificador de una regla de análisis.Initializes a new instance of the SuppressMessageAttribute class, specifying the category of the static analysis tool and the identifier for an analysis rule.

Propiedades

Category Category Category Category

Obtiene la categoría que identifica la clasificación del atributo.Gets the category identifying the classification of the attribute.

CheckId CheckId CheckId CheckId

Obtiene el identificador de la regla de la herramienta de análisis estático que se va a suprimir.Gets the identifier of the static analysis tool rule to be suppressed.

Justification Justification Justification Justification

Obtiene o establece la justificación para suprimir el mensaje de análisis de código.Gets or sets the justification for suppressing the code analysis message.

MessageId MessageId MessageId MessageId

Obtiene o establece un argumento opcional que amplía los criterios de exclusión.Gets or sets an optional argument expanding on exclusion criteria.

Scope Scope Scope Scope

Obtiene o establece el ámbito del código que es relevante para el atributo.Gets or sets the scope of the code that is relevant for the attribute.

Target Target Target Target

Obtiene o establece una ruta de acceso completa que representa el destino del atributo.Gets or sets a fully qualified path that represents the target of the attribute.

TypeId TypeId TypeId TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Métodos

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Devuelve un valor que indica si esta instancia es igual que un objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Implementaciones de interfaz explícitas

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Se aplica a