SuppressMessageAttribute Classe

Definição

Namespace:

System.Diagnostics.CodeAnalysis

Assembly:

System.Runtime.dll

Origem:

SuppressMessageAttribute.cs

Suprime o relatório de uma violação de regra de análise de código específica, permitindo várias supressões em um único artefato de código. Não se aplica a diagnóstico do 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

Herança

Object

Attribute

SuppressMessageAttribute

Atributos

AttributeUsageAttribute ConditionalAttribute

Exemplos

O exemplo de código a seguir mostra o uso do SuppressMessageAttribute atributo para suprimir mensagens de aviso de desempenho.

#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

Comentários

Esse atributo pode ser aplicado a qualquer elemento de aplicativo. Para obter uma lista completa das violações que podem ser suprimidas, consulte Regras de qualidade de código.

Observação

O ConditionalAttribute é aplicado a essa classe, especificando o símbolo de pré-processamento "CODE_ANALYSIS" como o símbolo condicional que determina se a chamada de atributo está incluída ou omitida. Se o símbolo for definido, a chamada de atributo será incluída; caso contrário, a chamada será omitida.

Quando você clica com o botão direito do mouse em um aviso de análise de código no Visual Studio e escolhe Suprimir <ID>> de regra no Arquivo de Supressão ou Suprimir <ID>> de regra na Origem (atributo), um atributo SuppressMessage é adicionado ao arquivo de supressões globais ou ao arquivo de código-fonte. Para obter mais informações sobre o atributo SuppressMessage e seu uso no Visual Studio, consulte Suprimir violações de análise de código.

Construtores

SuppressMessageAttribute(String, String)

Inicializa uma nova instância da SuppressMessageAttribute classe , especificando a categoria da ferramenta de análise de código e o identificador de uma regra de análise.

Propriedades

Category	Obtém a categoria que identifica a classificação do atributo.
CheckId	Obtém o identificador da regra da ferramenta de análise de código a ser suprimida.
Justification	Obtém ou define a justificativa para suprimir a mensagem de análise de código.
MessageId	Obtém ou define os critérios de exclusão expandidos.
Scope	Obtém ou define o escopo do código relevante para o atributo.
Target	Obtém ou define um caminho totalmente qualificado que representa o destino de análise de código.
TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)