次の方法で共有

In Source Suppression の概要

更新 : 2007 年 11 月

ソース内抑制とは、SuppressMessage 属性を使用して、コ―ド分析における規則違反を抑制または無視することをいいます。SuppressMessage 属性は条件属性であり、コンパイル時にコンパイル シンボル CODE_ANALYSIS を定義した場合のみマネージ コード アセンブリの IL メタデータに含められます。C++ では、同じ機能を CA_SUPPRESS_MESSAGE と CA_GLOBAL_SUPPRESS_MESSAGE の 2 つのマクロによって実現します。

ソース内抑制メタデータが誤って出荷され、そのサイズが拡大することによって実行やパフォーマンスが影響を受けるような事態を避けるために、ソース内抑制をデバッグ ビルドやチェックイン ビルドで使用することをお勧めします。

ms244717.alert_note(ja-jp,VS.90).gifメモ :

これらの属性をハンド コードする必要はありません。詳細については、「方法 : メニュー項目を使って警告を抑制する」を参照してください。

SuppressMessage 属性

[エラー一覧] でコード分析の警告を右クリックし、[メッセージの非表示] をクリックすると、コードまたはプロジェクトのグローバル抑制ファイルに SuppressMessage 属性が追加されます。

SuppressMessage 属性は次の形式で定義します。

<Scope:SuppressMessage("Rule Category", "Rule Id", "Justification", "MessageId", Scope = "Scope", Target = "Target")>

[Scope:SuppressMessage("Rule Category", "Rule Id", "Justification", "MessageId", Scope = "Scope", Target = "Target")]

各要素の意味は次のとおりです。

  • Rule Category - 規則を定義するカテゴリ。

  • Rule Id - 規則の識別子。規則 ID には、短い形式の名前と長い形式の名前がどちらもサポートされます。短い形式の名前は CAXXXX に、長い形式の名前は CAXXXX:FriendlyTypeName になります。

  • Justification - メッセージを抑制する理由を説明するテキスト。

  • Message Id - 各メッセージが報告する問題の一意の識別子。

  • Scope - 警告を抑制する対象。Target が指定されなかった場合、Scope が属性の対象に設定されます。次のスコープがサポートされます。

    • モジュール

    • 名前空間

    • リソース

    • 型

    • メンバ

    • パラメータ

  • Target - 警告を抑制する対象を指定するための識別子。この識別子には完全修飾項目名を使用する必要があります。

SuppressMessage の使用方法

コード分析の警告は、SuppressMessage 属性のインスタンスが適用されるレベルで抑制されます。これは、抑制情報を違反が発生するコードに密に結合するためです。

抑制属性を指定する際、一般には、規則カテゴリと規則識別子 (オプションで規則の名称を指定することも可能) が使用されます。次に例を示します。

[SuppressMessage("Microsoft.Design", "CA1039:ListsAreStrongTyped")]

パフォーマンス上の要件が厳しく、ソース内抑制のメタデータを可能な限り小さくする必要がある場合は、規則の名前を省略することができます。規則を一意に識別するには、規則カテゴリと規則 ID だけで十分です。次に例を示します。

[SuppressMessage("Microsoft.Design", "CA1039")]

この形式は、保守性の点でお勧めできません。

メソッド本体内の複数の違反を抑制する方法

属性をメソッドに対して適用することはできますが、メソッド本体に埋め込むことはできません。ただし、識別子をメッセージ ID として指定すると、1 つのメソッドにおける同じ違反の複数の出現を識別できます。

Imports System

Namespace InSourceSuppression
    Public Class Class1
        <System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", _
        "CA1801:ReviewUnusedParameters", MessageId:="guid")> _
        Shared Function IsValidGuid(ByVal guid As String) As Boolean
            Try
                Return True
            Catch e As ArgumentNullException
            Catch e As OverflowException
            Catch e As FormatException
            End Try

            Return False
        End Function
    End Class
End Namespace

using System;

namespace InSourceSuppression
{
    public class Class1
    {
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage",
    "CA1806:DoNotIgnoreMethodResults", MessageId = "System.Guid")]
        public static bool IsValidGuid(string guid)
        {
            try
            {
              new Guid(guid); //Causes CA1806: DoNotIgnoreMethodResults
              return true;
            }
            catch (ArgumentNullException) {}
            catch (OverflowException) {}
            catch (FormatException) {}
            return false;
        }
    }
}

生成されたコード

マネージ コード コンパイラや一部のサードパーティ製ツールは、迅速なコード開発を目的とするコードを生成します。ソース ファイルに含まれるコンパイラ生成のコードは、通常、GenerateCodeAttribute 属性でマークされます。

生成されたコードでコード分析の警告とエラーを抑制するかどうかを指定できます。このような警告やエラーを抑制する方法については、「マネージ コードのコード分析プロパティ」を参照してください。

アセンブリ全体または 1 つのパラメータに適用された GenerateCodeAttribute 属性は、コード分析では無視されます。このような状況はほとんど発生しません。

グローバル レベルの抑制

マネージ コード分析ツールは、アセンブリ、モジュール、型、メンバ、パラメータの各レベルで適用された SuppressMessage 属性を調べます。リソースおよび名前空間に対しても違反が検出されます。これらの違反については、グローバル レベルで適用し、スコープと対象を指定する必要があります。たとえば、次のメッセージでは、名前空間の違反が抑制されます。

[module: SuppressMessage("Microsoft.Design", "CA1020:AvoidNamespacesWithFewTypes", Scope = "namespace", Target = "MyNamespace")]

ms244717.alert_note(ja-jp,VS.90).gifメモ :

名前空間をスコープとして警告を抑制すると、名前空間それ自体に対する警告が抑制されます。名前空間に含まれる型に対する警告は抑制されません。

明示的にスコープを指定することにより、あらゆる違反を抑制できます。このような抑制はグローバル レベルで指定されている必要があります。型を修飾することによってメンバ レベルの抑制を指定することはできません。

コンパイラによって生成されたコードなど、明示的に指定されたユーザー ソースとの対応関係を持たないコードを参照するメッセージについては、必ずグローバル レベルの抑制を使用します。たとえば、次のコードはコンパイラによって生成されたコンストラクタに対する違反を抑制します。

[module: SuppressMessage("Microsoft.Design", "CA1055:AbstractTypesDoNotHavePublicConstructors", Scope="member", Target="Microsoft.Tools.FxCop.Type..ctor()")]

ms244717.alert_note(ja-jp,VS.90).gifメモ :

Target には、常に完全修飾項目名を指定します。

グローバル抑制ファイル

グローバル抑制ファイルには、グローバル レベルの違反または対象が指定されていない違反が保存されます。たとえば、アセンブリ レベルの違反などは、このファイルに格納されます。また、ASP.NET に関して抑制する一部の警告もこのファイルに格納されます。フォームのコードからプロジェクト レベルの設定にアクセスすることはできないためです。

参照

参照

System.Diagnostics.CodeAnalysis