CA1717:FlagsAttribute 列挙型のみが複数形の名前を含んでいなければなりません

  • [アーティクル]
プロパティ 値
ルール ID CA1717
Title FlagsAttribute 列挙型のみが複数形の名前を含んでいなければなりません
[カテゴリ] 名前を付ける
修正が中断ありか中断なしか あり
.NET 8 では既定で有効 いいえ

原因

列挙型の名前の末尾が複数形になっているのに、その列挙型が System.FlagsAttribute 属性でマークされていません。

デフォルトでは、この規則の対象は外部から参照できる列挙型のみですが、これは構成可能です。

規則の説明

名前付け規則では、列挙型の複数形の名前は、同時に複数の列挙値を指定できることを意味します。 FlagsAttribute は、列挙型でのビットごとの演算を実行できるビット フィールドとして、列挙型を処理する必要があることをコンパイラに指示します。

列挙型の値を一度に 1 つだけしか指定できない場合、列挙型の名前は単数形である必要があります。 たとえば、曜日を定義する列挙型で、複数の曜日を指定することが想定されているとします。 この列挙型には FlagsAttribute を含める必要があり、"Days" という名前を付けることができます。 1 日だけを指定できるようにする同様の列挙型では、この属性は含めず、"Day" という名前を付けます。

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

違反の修正方法

列挙型の名前を単数形にするか、FlagsAttribute を追加します。

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

名前が単数形の末尾で終わる場合は、この規則による警告を抑制しても問題ありません。

警告を抑制する

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

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

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

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

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

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

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

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

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

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

dotnet_code_quality.CAXXXX.api_surface = private, internal

関連項目