SuppressMessageAttribute Třída

Definice

Obor názvů:

System.Diagnostics.CodeAnalysis

Sestavení:

System.Runtime.dll

Zdroj:

SuppressMessageAttribute.cs

Potlačí hlášení konkrétního porušení pravidla analýzy kódu, což umožňuje více potlačení u jednoho 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í 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 u libovolného elementu aplikace. Úplný seznam porušení, která je možné potlačit, najdete v tématu Pravidla kvality kódu.

Poznámka

Použije ConditionalAttribute se na tuto třídu a určí 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 definován symbol, je zahrnuto volání atributu; v opačném případě je volání vynecháno.

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

Konstruktory

SuppressMessageAttribute(String, String)

Inicializuje novou instanci SuppressMessageAttribute třídy a určí 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é mají být potlačeny.
Justification	Získá nebo nastaví odůvodnění pro 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 tuto Attributetřídu . (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()	Získá aktuální Type instanci. (Zděděno od Object)
IsDefaultAttribute()	Při přepsání v odvozené třídě označuje, zda je hodnota této instance 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á označuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)