SuppressMessageAttribute Třída

Definice

Potlačuje 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
SuppressMessageAttribute
Atributy

Příklady

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

#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.

Poznámka

Použije ConditionalAttribute se pro tuto třídu a zadá předzpracující symbol "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ž kliknete pravým tlačítkem myši na upozornění analýzy kódu v Visual Studio a zvolíte Potlačit <rule-ID> > v souboru potlačení nebo potlačit <rule-ID> > ve zdroji (atributu), přidá se atribut SuppressMessage do globálního souboru potlačení nebo do souboru zdrojového kódu. Další informace o atributu SuppressMessage a jeho použití v Visual Studio naleznete v tématu Potlačení porušení analýzy kódu.

Konstruktory

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

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

Equals(Object)

Vrací hodnotu, která určuje, zda je tato instance rovna zadanému objektu.

(Zděděno od Attribute)
GetHashCode()

Vrátí hodnotu hash pro tuto instanci.

(Zděděno od Attribute)
GetType()

Type Získá aktuální instanci.

(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 odvozené třídy.

(Zděděno od Attribute)
Match(Object)

Při přepsání v odvozené třídě vrátí hodnotu, která označuje, zda se tato instance rovná zadanému objektu.

(Zděděno od Attribute)
MemberwiseClone()

Vytvoří použádnou kopii aktuálního souboru Object.

(Zděděno od Object)
ToString()

Vrátí řetězec, který představuje aktuální objekt.

(Zděděno od Object)

Explicitní implementace rozhraní

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

Mapuje sadu názvů na odpovídající sadu identifikátorů pro rozesílání.

(Zděděno od Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Načte informace o typu objektu, který lze použít k získání informací o typu rozhraní.

(Zděděno od Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Získá počet rozhraní typu informací, které objekt poskytuje (0 nebo 1).

(Zděděno od Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Poskytuje přístup k vlastnostem a metodám vystaveným objektem.

(Zděděno od Attribute)

Platí pro