SuppressMessageAttribute 类

定义

命名空间:

System.Diagnostics.CodeAnalysis

程序集:

System.Runtime.dll

Source:

SuppressMessageAttribute.cs

取消报告特定代码分析规则违规，并允许多次取消单个代码项目。 不适用于编译器诊断。

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

继承

Object

Attribute

SuppressMessageAttribute

属性

AttributeUsageAttribute ConditionalAttribute

示例

下面的代码示例演示如何使用 SuppressMessageAttribute 属性来禁止显示性能警告消息。

#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

注解

此属性可应用于任何应用程序元素。 有关可禁止的冲突的完整列表，请参阅 代码质量规则。

注意

ConditionalAttribute应用于此类，将预处理符号“CODE_ANALYSIS”指定为确定是包含还是省略属性调用的条件符号。 如果定义了符号，则包括属性调用;否则，将省略调用。

在 Visual Studio 中右键单击代码分析警告并选择“禁止<显示文件中的规则 ID>>”或“禁止<显示源 (属性) 中的规则 ID>>”时，SuppressMessage 属性将添加到全局抑制文件或源代码文件中。 有关 SuppressMessage 属性及其在 Visual Studio 中的用法的详细信息，请参阅 禁止显示代码分析冲突。

构造函数

SuppressMessageAttribute(String, String)

初始化 SuppressMessageAttribute 类的新实例，同时指定代码分析工具的类别和分析规则的标识符。

属性

Category	获取标识特性分类的类别。
CheckId	获取要取消的代码分析工具规则的标识符。
Justification	获取或设置用于取消代码分析消息的规则。
MessageId	获取或设置展开的排除条件。
Scope	获取或设置与属性相关的代码的范围。
Target	获取或设置表示代码分析目标的完全限定的路径。
TypeId	在派生类中实现时，获取此 Attribute 的唯一标识符。 (继承自 Attribute)

方法

Equals(Object)	返回一个值，该值指示此实例是否与指定的对象相等。 (继承自 Attribute)
GetHashCode()	返回此实例的哈希代码。 (继承自 Attribute)
GetType()	获取当前实例的 Type。 (继承自 Object)
IsDefaultAttribute()	在派生类中重写时，指示此实例的值是否是派生类的默认值。 (继承自 Attribute)
Match(Object)	当在派生类中重写时，返回一个指示此实例是否等于指定对象的值。 (继承自 Attribute)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ToString()	返回表示当前对象的字符串。 (继承自 Object)