SuppressMessageAttribute Osztály

Definíció

Névtér:

System.Diagnostics.CodeAnalysis

Szerelvények:

netstandard.dll, System.Runtime.dll

Forrás:

SuppressMessageAttribute.cs

Letiltja egy adott kódelemzési szabály megsértésének jelentését, így több letiltás is engedélyezve van egyetlen kódösszetevőn. Nem vonatkozik a fordítódiagnosztikára.

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

Öröklődés

Object

Attribute

SuppressMessageAttribute

Attribútumok

AttributeUsageAttribute ConditionalAttribute

Példák

Az alábbi példakód az attribútum használatát mutatja be a SuppressMessageAttribute teljesítményriasztási üzenetek letiltására.

#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

Megjegyzések

Ez az attribútum bármely alkalmazáselemre alkalmazható. A letiltható szabálysértések teljes listáját a Kódminőségi szabályok című témakörben találja.

Note

A ConditionalAttribute rendszer ezt az osztályt alkalmazza, és az "CODE_ANALYSIS" előfeldolgozási szimbólumot adja meg feltételes szimbólumként, amely meghatározza, hogy az attribútumhívás szerepel-e vagy nem szerepel-e benne. Ha a szimbólum definiálva van, az attribútumhívás is megjelenik; ellenkező esetben a hívás ki van hagyva.

Ha a jobb gombbal a kódelemzési figyelmeztetésre kattint a Visual Studio, és a Suppress rule-ID a Letiltási fájlban vagy Suppress < A SuppressMessage attribútum rule-ID a Forrás (attribútum) fájlban egy SuppressMessage attribútumot ad hozzá a globális letiltási fájlhoz vagy a forráskódfájlhoz. A SuppressMessage attribútumról és annak Visual Studio való használatáról a Suppress kódelemzési szabálysértések című témakörben talál további információt.

Konstruktorok

Name	Description
SuppressMessageAttribute(String, String)	Inicializálja az SuppressMessageAttribute osztály új példányát, megadva a kódelemző eszköz kategóriáját és az elemzési szabály azonosítóját.

Tulajdonságok

Name	Description
Category	Lekéri az attribútum besorolását azonosító kategóriát.
CheckId	Lekéri a letiltandó kódelemző eszközszabály azonosítóját.
Justification	Lekéri vagy beállítja a kódelemzési üzenet letiltásának indoklását.
MessageId	Lekéri vagy beállítja a kiterjesztett kizárási feltételeket.
Scope	Lekéri vagy beállítja az attribútum szempontjából releváns kód hatókörét.
Target	Lekéri vagy beállítja a kódelemzési célnak megfelelő teljes elérési utat.
TypeId	Ha származtatott osztályban implementálják, ehhez egy egyedi azonosítót Attributekap. (Öröklődés forrása Attribute)

Metódusok

Name	Description
Equals(Object)	Olyan értéket ad vissza, amely jelzi, hogy ez a példány egyenlő-e egy adott objektummal. (Öröklődés forrása Attribute)
GetHashCode()	A példány kivonatkódját adja vissza. (Öröklődés forrása Attribute)
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
IsDefaultAttribute()	Ha egy származtatott osztályban felül van bírálva, azt jelzi, hogy a példány értéke-e a származtatott osztály alapértelmezett értéke. (Öröklődés forrása Attribute)
Match(Object)	Származtatott osztály felülírásakor egy olyan értéket ad vissza, amely jelzi, hogy ez a példány egy adott objektummal egyenlő-e. (Öröklődés forrása Attribute)
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)