SuppressMessageAttribute Třída

Definice

Obor názvů:

System.Diagnostics.CodeAnalysis

Sestavení:

netstandard.dll, System.Runtime.dll

Zdroj:

SuppressMessageAttribute.cs

Potlačí hlášení o porušení konkrétního pravidla analýzy kódu, což umožňuje více potlačení na jednom artefaktu kódu. Nevztahuje se na diagnostiku kompilátoru.

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

Dědičnost

Object

Attribute

SuppressMessageAttribute

Atributy

AttributeUsageAttribute ConditionalAttribute

Příklady

Následující příklad kódu ukazuje použití atributu SuppressMessageAttribute k potlačení zpráv upozornění výkonu.

#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

Poznámky

Tento atribut lze použít pro libovolný prvek aplikace. Úplný seznam porušení, která lze potlačit, najdete v tématu Pravidla kvality kódu.

Note

U ConditionalAttribute této třídy se použije symbol předběžného zpracování "CODE_ANALYSIS" jako podmíněný symbol, který určuje, zda je volání atributu zahrnuto nebo vynecháno. Pokud je symbol definován, volání atributu je zahrnuto; jinak je volání vynecháno.

Když v Visual Studio kliknete pravým tlačítkem na upozornění analýzy kódu a zvolíte Suppress <rule-ID>> v souboru potlačení nebo Suppress <rule-ID>> ve zdroji (atribut), do souboru globálního potlačení nebo do souboru zdrojového kódu se přidá atribut SuppressMessage. Další informace o atributu SuppressMessage a jeho použití v Visual Studio najdete v tématu Suppress porušení analýzy kódu.

Konstruktory

Name	Description
SuppressMessageAttribute(String, String)	Inicializuje novou instanci SuppressMessageAttribute třídy, určuje kategorii nástroje pro analýzu kódu a identifikátor pravidla analýzy.

Vlastnosti

Name	Description
Category	Získá kategorii identifikující klasifikaci atributu.
CheckId	Získá identifikátor pravidla nástroje pro analýzu kódu, které má být potlačeno.
Justification	Získá nebo nastaví odůvodnění potlačení zprávy analýzy kódu.
MessageId	Získá nebo nastaví rozšířená kritéria vyloučení.
Scope	Získá nebo nastaví obor kódu, který je relevantní pro atribut.
Target	Získá nebo nastaví plně kvalifikovanou cestu, která představuje cíl analýzy kódu.
TypeId	Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute. (Zděděno od Attribute)

Metody

Name	Description
Equals(Object)	Vrátí hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute)
GetHashCode()	Vrátí kód hash pro tuto instanci. (Zděděno od Attribute)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě určuje, zda hodnota této instance je výchozí hodnotou pro odvozenou třídu. (Zděděno od Attribute)
Match(Object)	Při přepsání v odvozené třídě vrátí hodnotu, která určuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)