SuppressMessageAttribute Sınıf

Tanım

Ad Alanı:

System.Diagnostics.CodeAnalysis

Bütünleştirilmiş Kodlar:

netstandard.dll, System.Runtime.dll

Kaynak:

SuppressMessageAttribute.cs

Belirli bir kod analizi kuralı ihlalinin bildirilmesi engellenir ve tek bir kod yapıtı üzerinde birden çok gizlemeye izin verir. Derleyici tanılamaları için geçerli değildir.

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

Devralma

Object

Attribute

SuppressMessageAttribute

Öznitelikler

AttributeUsageAttribute ConditionalAttribute

Örnekler

Aşağıdaki kod örneği, performans uyarı iletilerini engellemek için özniteliğin SuppressMessageAttribute kullanımını gösterir.

#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

Açıklamalar

Bu öznitelik herhangi bir uygulama öğesine uygulanabilir. Gizlenebilecek ihlallerin tam listesi için bkz. Kod kalitesi kuralları.

Note

ConditionalAttribute, öznitelik çağrısının dahil edilip edilmediğini belirleyen koşullu simge olarak "CODE_ANALYSIS" ön işleme simgesini belirterek bu sınıfa uygulanır. Simge tanımlanmışsa, öznitelik çağrısı dahil edilir; aksi takdirde çağrı atlanır.

Visual Studio'da bir kod analizi uyarısına sağ tıklayıp Suppress rule-ID Dosyasını Gizleme Dosyası veya Suppress < > >c4 />rule-ID in Source (attribute), SuppressMessage özniteliği genel gizleme dosyasına veya kaynak kod dosyasına eklenir. SuppressMessage özniteliği ve Visual Studio kullanımı hakkında daha fazla bilgi için bkz. Suppress kod analizi ihlalleri.

Oluşturucular

Name	Description
SuppressMessageAttribute(String, String)	Kod çözümleme aracının kategorisini SuppressMessageAttribute ve bir çözümleme kuralının tanımlayıcısını belirterek sınıfının yeni bir örneğini başlatır.

Özellikler

Name	Description
Category	Özniteliğin sınıflandırmasını tanımlayan kategoriyi alır.
CheckId	Gizlenecek kod çözümleme aracı kuralının tanımlayıcısını alır.
Justification	Kod çözümleme iletisinin gizlenmesi için gerekçeyi alır veya ayarlar.
MessageId	Genişletilmiş dışlama ölçütlerini alır veya ayarlar.
Scope	Özniteliğiyle ilgili kodun kapsamını alır veya ayarlar.
Target	Kod çözümleme hedefini temsil eden tam yol alır veya ayarlar.
TypeId	Türetilmiş bir sınıfta uygulandığında, bu Attributeiçin benzersiz bir tanımlayıcı alır. (Devralındığı yer: Attribute)

Yöntemler

Name	Description
Equals(Object)	Bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
GetHashCode()	Bu örneğin karma kodunu döndürür. (Devralındığı yer: Attribute)
GetType()	Geçerli örneğin Type alır. (Devralındığı yer: Object)
IsDefaultAttribute()	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin değerinin türetilmiş sınıf için varsayılan değer olup olmadığını gösterir. (Devralındığı yer: Attribute)
Match(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
MemberwiseClone()	Geçerli Objectbasit bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden bir dize döndürür. (Devralındığı yer: Object)