SuppressMessageAttribute Classe
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
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
- Atributos
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
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.
Suppress |
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. |
Category |
Obtém a categoria que identifica a classificação do atributo. |
Check |
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. |
Message |
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. |
Type |
Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute) |
Equals(Object) |
Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute) |
Get |
Retorna o código hash para a instância. (Herdado de Attribute) |
Get |
Obtém o Type da instância atual. (Herdado de Object) |
Is |
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) |
Memberwise |
Cria uma cópia superficial do Object atual. (Herdado de Object) |
To |
Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object) |
_Attribute. |
Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição. (Herdado de Attribute) |
_Attribute. |
Recupera as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface. (Herdado de Attribute) |
_Attribute. |
Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1). (Herdado de Attribute) |
_Attribute. |
Fornece acesso a propriedades e métodos expostos por um objeto. (Herdado de Attribute) |
Produto | Versões |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.0, 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1 |
UWP | 10.0 |
Comentários do .NET
O .NET é um projeto código aberto. Selecione um link para fornecer comentários: