SuppressMessageAttribute クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

SuppressMessageAttribute クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

特定の静的分析ツール規則違反の報告を抑制します。1 つのコードで複数の抑制を実行できます。

名前空間: System.Diagnostics.CodeAnalysis
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.All, Inherited:=False, AllowMultiple:=True)>
 _
<ConditionalAttribute("CODE_ANALYSIS")> _
Public NotInheritable Class
 SuppressMessageAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As SuppressMessageAttribute

[AttributeUsageAttribute(AttributeTargets.All, Inherited=false,
 AllowMultiple=true)] 
[ConditionalAttribute("CODE_ANALYSIS")] 
public sealed class SuppressMessageAttribute
 : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::All, Inherited=false,
 AllowMultiple=true)] 
[ConditionalAttribute(L"CODE_ANALYSIS")] 
public ref class SuppressMessageAttribute sealed
 : public Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.All, Inherited=false,
 AllowMultiple=true) */ 
/** @attribute ConditionalAttribute("CODE_ANALYSIS") */ 
public final class SuppressMessageAttribute
 extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.All, Inherited=false,
 AllowMultiple=true) 
ConditionalAttribute("CODE_ANALYSIS") 
public final class SuppressMessageAttribute
 extends Attribute

解説

この属性は、任意のアプリケーション要素に適用できます。

メモ
ConditionalAttribute は、属性呼び出しを含めるか省略するかを決定する条件シンボルとしてプリプロセスシンボル "CODE_ANALYSIS" を指定して、このクラスに適用されます。シンボルが定義されている場合、属性呼び出しが含められ、それ以外の場合は省略されます。

メモ

ConditionalAttribute は、属性呼び出しを含めるか省略するかを決定する条件シンボルとしてプリプロセスシンボル "CODE_ANALYSIS" を指定して、このクラスに適用されます。シンボルが定義されている場合、属性呼び出しが含められ、それ以外の場合は省略されます。

使用例

SuppressMessageAttribute 属性を使用して警告メッセージの実行を抑制する方法を次のコード例に示します。

Visual Basic

#Const CODE_ANALYSIS = True
Imports System
Imports System.Diagnostics.CodeAnalysis



Class Library
    
    <SuppressMessage("Microsoft.Performance", "CA1801:AvoidUnusedParameters",
 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

#define CODE_ANALYSIS
using System;
using System.Diagnostics.CodeAnalysis;

namespace CodeAnalysisSample
{
    class Library
    {
        [SuppressMessage("Microsoft.Performance", "CA1801:AvoidUnusedParameters",
 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;
        }

    }
}