可能性の高い JSON 文字列が検出されました (JSON002)
プロパティ | 値 |
---|---|
ルール ID | JSON002 |
Title | 可能性の高い JSON 文字列が検出されました |
カテゴリ | スタイル |
Subcategory | 該当なし |
該当言語 | C#、Visual Basic |
[オプション] | 該当なし |
概要
この規則は、JSON リテラル文字列が検出されたが、明示的に識別されない場所にフラグを設定します。 JSON は、json 文字列//lang=json
の前に in行コメント またはコメントを使用して識別されます(例//lang=json,strict
: 後者のコメントでは、JSON 解釈に厳密モードが使用されます。
ツール オプション>テキスト エディター>C# | Visual Basic>Advanced>JSON 文字列で JSON エディター オプションが有効になっている場合、エディターで>このルールにフラグが設定されない場合があります。
この規則は IDE 専用であり、コマンド ライン シナリオには適用されません。
[オプション]
この規則では、オプションはサポートされていません。 JSON が指定されている場合に IDE で構成できるオプションについては、「無効な JSON パターン (JSON001)」を参照してください。
例
次のコード スニペットは、可能性のある JSON 文字列が検出される可能性がある例を示しています。
// Code with violations
var v = """{ "pie": true, "cherry": [1, 2, 3] }""";
// Fixed code
// lang=json,strict
var v = """{ "pie": true, "cherry": [1, 2, 3] }""";
// Fixed code
var v = /*lang=json,strict*/ """{ "pie": true, "cherry": [1, 2, 3] }""";
警告を抑制する
単一の違反だけを抑制する場合は、ソース ファイルにプリプロセッサ ディレクティブを追加して無効にしてから、規則を再度有効にします。
#pragma warning disable JSON002
// The code that's violating the rule is on this line.
#pragma warning restore JSON002
ファイル、フォルダー、またはプロジェクトの規則を無効にするには、構成ファイルでその重要度を none
に設定します。
[*.{cs,vb}]
dotnet_diagnostic.JSON002.severity = none
詳細については、「コード分析の警告を抑制する方法」を参照してください。