SuppressMessageAttribute Kelas

Definisi

Ruang nama:

System.Diagnostics.CodeAnalysis

Rakitan:

System.Runtime.dll

Sumber:

SuppressMessageAttribute.cs

Menekan pelaporan pelanggaran aturan analisis kode tertentu, memungkinkan beberapa penekanan pada artefak kode tunggal. Tidak berlaku untuk diagnostik pengkompilasi.

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

Warisan

Object

Attribute

SuppressMessageAttribute

Atribut

AttributeUsageAttribute ConditionalAttribute

Contoh

Contoh kode berikut menunjukkan penggunaan SuppressMessageAttribute atribut untuk menekan pesan peringatan performa.

#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

Keterangan

Atribut ini dapat diterapkan ke elemen aplikasi apa pun. Untuk daftar lengkap pelanggaran yang dapat ditekan, lihat Aturan kualitas kode.

Catatan

ConditionalAttribute diterapkan ke kelas ini, menentukan simbol praprossesi "CODE_ANALYSIS" sebagai simbol kondisional yang menentukan apakah panggilan atribut disertakan atau dihilangkan. Jika simbol didefinisikan, panggilan atribut disertakan; jika tidak, panggilan dihilangkan.

Saat Anda mengklik kanan peringatan analisis kode di Visual Studio dan memilih Sembunyikan <ID>> aturan di File Supresi atau Sembunyikan <ID>> aturan di Sumber (atribut), atribut SuppressMessage ditambahkan ke file supresi global atau ke file kode sumber. Untuk informasi selengkapnya tentang atribut SuppressMessage dan penggunaannya di Visual Studio, lihat Menyembunyikan pelanggaran analisis kode.

Konstruktor

SuppressMessageAttribute(String, String)

Menginisialisasi instans SuppressMessageAttribute baru kelas, menentukan kategori alat analisis kode dan pengidentifikasi untuk aturan analisis.

Properti

Category	Mendapatkan kategori yang mengidentifikasi klasifikasi atribut.
CheckId	Mendapatkan pengidentifikasi aturan alat analisis kode yang akan ditekan.
Justification	Mendapatkan atau mengatur pembenaran untuk menekan pesan analisis kode.
MessageId	Mendapatkan atau menetapkan kriteria pengecualian yang diperluas.
Scope	Mendapatkan atau mengatur cakupan kode yang relevan untuk atribut .
Target	Mendapatkan atau menetapkan jalur yang sepenuhnya memenuhi syarat yang mewakili target analisis kode.
TypeId	Ketika diimplementasikan di kelas turunan, mendapatkan pengidentifikasi unik untuk ini Attribute. (Diperoleh dari Attribute)

Metode

Equals(Object)	Mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
GetHashCode()	Mengembalikan kode hash untuk instans ini. (Diperoleh dari Attribute)
GetType()	Mendapatkan instans Type saat ini. (Diperoleh dari Object)
IsDefaultAttribute()	Ketika ditimpa di kelas turunan, menunjukkan apakah nilai instans ini adalah nilai default untuk kelas turunan. (Diperoleh dari Attribute)
Match(Object)	Saat ditimpa di kelas turunan, mengembalikan nilai yang menunjukkan apakah instans ini sama dengan objek tertentu. (Diperoleh dari Attribute)
MemberwiseClone()	Membuat salinan dangkal dari yang saat ini Object. (Diperoleh dari Object)
ToString()	Mengembalikan string yang mewakili objek saat ini. (Diperoleh dari Object)