SuppressMessageAttribute SuppressMessageAttribute SuppressMessageAttribute SuppressMessageAttribute Class

Определение

Подавляет сообщение о нарушении правила определенного инструмента статического анализа, позволяет подавить все сообщения, которые относятся к одному артефакту кода.Suppresses reporting of a specific static analysis tool rule violation, allowing multiple suppressions on a single code artifact.

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
type SuppressMessageAttribute = class
    inherit Attribute
Public NotInheritable Class SuppressMessageAttribute
Inherits Attribute
Наследование
SuppressMessageAttributeSuppressMessageAttributeSuppressMessageAttributeSuppressMessageAttribute
Атрибуты

Примеры

В следующем примере кода показано использование SuppressMessageAttribute атрибут для подавления предупреждений производительности.The following code example shows the use of the SuppressMessageAttribute attribute to suppress performance warning messages.

#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
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 'FileNode
End Class 'Library 

Комментарии

Этот атрибут может применяться к любому элементу приложения.This attribute can be applied to any application element. Полный список нарушений, которые могут быть отключены, см. в разделе анализ кода для предупреждений управляемого кода.For a complete list of the violations that can be suppressed, see Code Analysis for Managed Code Warnings.

Примечание

ConditionalAttribute Применяется к этому классу, указав символа предварительной обработки «CODE_ANALYSIS» в качестве условного символ, который определяет, включены ли опустить атрибут вызова.The ConditionalAttribute is applied to this class, specifying the preprocessing symbol "CODE_ANALYSIS" as the conditional symbol that determines whether the attribute call is included or omitted. Если этот символ определен, вызов атрибута включен; в противном случае вызов пропускается.If the symbol is defined, the attribute call is included; otherwise, the call is omitted.

Если щелкнуть правой кнопкой предупреждение анализа кода в Visual Studio список ошибок и нажмите кнопку подавить сообщения, SuppressMessage этот атрибут будет добавлен в код или файл глобального подавления проекта.When you right-click a Code Analysis warning in the Visual Studio Error List and then click Suppress Message(s), a SuppressMessage attribute is added either in your code or to the project's global suppressions file. Дополнительные сведения о SuppressMessage атрибут и его использование в Visual Studio, см. в разделе в обзор исходного кода для подавления.For more information about the SuppressMessage attribute and its use in Visual Studio, see In Source Suppression Overview.

Конструкторы

SuppressMessageAttribute(String, String) SuppressMessageAttribute(String, String) SuppressMessageAttribute(String, String) SuppressMessageAttribute(String, String)

Инициализирует новый экземпляр класса SuppressMessageAttribute с указанными категорией инструмента статического анализа и идентификатором правила анализа.Initializes a new instance of the SuppressMessageAttribute class, specifying the category of the static analysis tool and the identifier for an analysis rule.

Свойства

Category Category Category Category

Возвращает категорию, определяющую классификацию атрибута.Gets the category identifying the classification of the attribute.

CheckId CheckId CheckId CheckId

Возвращает идентификатор подавляемого правила инструмента анализа.Gets the identifier of the static analysis tool rule to be suppressed.

Justification Justification Justification Justification

Возвращает или определяет причину подавления сообщения анализа кода.Gets or sets the justification for suppressing the code analysis message.

MessageId MessageId MessageId MessageId

Возвращает или устанавливает необязательное расширение аргумента для критерия исключения.Gets or sets an optional argument expanding on exclusion criteria.

Scope Scope Scope Scope

Возвращает или задает область кода, к которой относится атрибут.Gets or sets the scope of the code that is relevant for the attribute.

Target Target Target Target

Возвращает или задает полный путь, представляющий целевой элемент атрибута.Gets or sets a fully qualified path that represents the target of the attribute.

TypeId TypeId TypeId TypeId

При реализации в производном классе возвращает уникальный идентификатор для этого Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Методы

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Возвращает хэш-код для данного экземпляра.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

При переопределении в производном классе показывает, является ли значение данного экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Явные реализации интерфейса

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

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые могут использоваться для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Применяется к