CA1711:識別子は、不適切なサフィックスを含むことはできません

  • [アーティクル]
プロパティ 値
ルール ID CA1711
Title 識別子は、不適切なサフィックスを含むことはできません
[カテゴリ] 名前を付ける
修正が中断ありか中断なしか あり
.NET 8 では既定で有効 いいえ

原因

識別子のサフィックスが不適切です。

デフォルトでは、この規則の対象は外部から参照可能な識別子のみですが、これは構成可能です。

規則の説明

規則では、特定の基本型を拡張する型、特定のインターフェイスを実装する型、またはそのような型から派生した型の名前にのみ、固有の予約済みサフィックスを末尾に付けます。 その他の型名では、予約済みのサフィックスを使用しないでください。

予約済みのサフィックス、および関連付けられている基本型とインターフェイスを次の表に示します。

サフィックス 基本型/インターフェイス
属性 System.Attribute
コレクション System.Collections.ICollection

System.Collections.IEnumerable

System.Collections.Queue

System.Collections.Stack

System.Collections.Generic.ICollection<T>

System.Data.DataSet

System.Data.DataTable
Dictionary System.Collections.IDictionary

System.Collections.Generic.IDictionary<TKey,TValue>
EventArgs System.EventArgs
EventHandler イベント ハンドラーのデリゲート
例外 System.Exception
権限 System.Security.IPermission
キュー System.Collections.Queue
スタック System.Collections.Stack
ストリーム System.IO.Stream

その他に、次のサフィックスは使用しないでください。

  • Delegate
  • Enum
  • Impl (代わりに、Core を使用してください)
  • 型を以前のバージョンと区別するための Ex または類似のサフィックス
  • 列挙型の Flag または Flags

名前付け規則では、共通言語ランタイムをターゲットとするライブラリの統一的な名前の付け方が規定されています。 これにより、新しいソフトウェア ライブラリを習得するまでの時間を短縮でき、マネージド コード開発の専門家によってライブラリが開発されたという信頼を顧客に与えることができます。 詳細については、「名前付けのガイドライン」のクラス、構造体、およびインターフェイスに関するページを参照してください。

違反の修正方法

型名からサフィックスを削除します。

どのようなときに警告を抑制するか

アプリケーション ドメインでサフィックスに明確な意味がある場合を除き、この規則による警告を抑制しないでください。

警告を抑制する

単一の違反を抑制するだけの場合は、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、規則をもう一度有効にします。

#pragma warning disable CA1711
// The code that's violating the rule is on this line.
#pragma warning restore CA1711

ファイル、フォルダー、またはプロジェクトの規則を無効にするには、構成ファイルでその重要度を none に設定します。

[*.{cs,vb}]
dotnet_diagnostic.CA1711.severity = none

詳細については、「コード分析の警告を抑制する方法」を参照してください。

分析するコードを構成する

次のオプションを使用して、コードベースのどの部分に対してこの規則を実行するかを構成します。

これらのオプションを構成できる対象は、この規則だけ、それを適用するすべての規則、それを適用するこのカテゴリ (名前付け) のすべての規則のいずれかです。 詳細については、「コード品質規則の構成オプション」を参照してください。

特定の API サーフェイスを含める

ユーザー補助に基づいて、この規則を実行するコードベースの部分を構成できます。 たとえば、非パブリック API サーフェイスでのみ規則を実行するように指定するには、プロジェクトの .editorconfig ファイルに次のキーと値のペアを追加します。

dotnet_code_quality.CAXXXX.api_surface = private, internal

サフィックスを許可する

各サフィックスがパイプ文字 ("|") で区切られた、許可されているサフィックスの一覧を構成できます。 たとえば、Flag および Flags のサフィックスに対して規則を実行しないように指定するには、プロジェクトの .editorconfig ファイルに次のキーと値のペアを追加します。

dotnet_code_quality.ca1711.allowed_suffixes = Flag|Flags

関連項目