CA1707:識別子はアンダースコアを含むことはできません
プロパティ | 値 |
---|---|
ルール ID | CA1707 |
Title | 識別子はアンダースコアを含むことはできません |
[カテゴリ] | 名前を付ける |
修正が中断ありか中断なしか | 中断あり - アセンブリで発生した場合 中断なし - 型パラメーターで発生した場合。 |
.NET 8 では既定で有効 | いいえ |
原因
識別子名にアンダースコア (_) 文字が含まれています。
規則の説明
名前付け規則では、識別子名にアンダースコア (_) 文字を含めることができません。 この規則により、名前空間、型、メンバー、およびパラメーターがチェックされます。
名前付け規則では、共通言語ランタイムをターゲットとするライブラリの統一的な名前の付け方が規定されています。 これにより、新しいソフトウェア ライブラリを習得するまでの時間を短縮でき、マネージド コード開発の専門家によってライブラリが開発されたという信頼を顧客に与えることができます。
違反の修正方法
名前からすべてのアンダースコア文字を削除します。
どのようなときに警告を抑制するか
運用環境のコードでは警告を抑制しないでください。 ただし、テスト コードではこの警告を抑制しても問題ありません。
警告を抑制する
単一の違反を抑制するだけの場合は、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、規則をもう一度有効にします。
#pragma warning disable CA1707
// The code that's violating the rule is on this line.
#pragma warning restore CA1707
ファイル、フォルダー、またはプロジェクトの規則を無効にするには、構成ファイルでその重要度を none
に設定します。
[*.{cs,vb}]
dotnet_diagnostic.CA1707.severity = none
詳細については、「コード分析の警告を抑制する方法」を参照してください。
現在、アンダースコアを使用していて、変更できない Microsoft コードの既知のメソッドについては、規則を抑制する必要があります。
分析するコードを構成する
次のオプションを使用して、コードベースのどの部分に対してこの規則を実行するか構成します。
このオプションを構成できる対象は、この規則だけ、それを適用するすべての規則、それを適用するこのカテゴリ (名前付け) のすべての規則のいずれかです。 詳細については、「コード品質規則の構成オプション」を参照してください。
特定の API サーフェイスを含める
ユーザー補助に基づいて、この規則を実行するコードベースの部分を構成できます。 たとえば、非パブリック API サーフェイスでのみ規則を実行するように指定するには、プロジェクトの .editorconfig ファイルに次のキーと値のペアを追加します。
dotnet_code_quality.CAXXXX.api_surface = private, internal
関連規則
.NET