無効な JSON パターン (JSON001)

プロパティ
ルール ID JSON001
Title JSON パターンが無効です
カテゴリ スタイル
Subcategory 該当なし
該当言語 C#、Visual Basic
[オプション] 「オプション」セクションを参照してください

概要

この規則は、JSON リテラル文字列が必要な構文に準拠していない場所にフラグを設定します。 この規則は、特定された JSON に適用されます。これは、JSON 文字列の前に in行コメント またはコメントが含まれることによって決まります。たとえば//lang=json//lang=json,strict、 後者のコメントでは、JSON 解釈に厳密モードが使用されます。

この規則は IDE 専用であり、コマンド ライン シナリオには適用されません。

[オプション]

オプションでは、規則を適用する動作を指定します。

JSON として認識されるコードの場合は、ツール オプション テキスト エディター>C# | Visual Basic>Advanced を選択して >Visual Studio でオプション>を設定します。 JSON 文字列セクションでは、次のオプションを使用できます。

プロパティ 説明
JSON 文字列を色分けする JSON 文字列を色分けするかどうかを指定します。
無効な JSON を報告する 無効な JSON を報告するかどうかを指定します。
カーソルの下の関連コンポーネントを強調表示する クイック アクションで強調表示を使用するかどうかを 指定します

次のコード スニペットは、無効な JSON の例を示しています。

// Code with violations
// lang=json,strict
var v = """{ "pie": true, "cherry": [1, 2, 3 }""";

// Fixed code
// lang=json,strict
var v = """{ "pie": true, "cherry": [1, 2, 3] }""";

// Code with violations
//lang=json,strict
var v = """
{
   "pie": true, 
   // Comments not allowed in strict mode
   "cherry": [1, 2, 3]
}
""";

// Fixed code
//lang=json
var v = """
{
   "pie": true, 
   // Comments allowed if not using strict mode
   "cherry": [1, 2, 3]
}
""";

警告を抑制する

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

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

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

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

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

関連項目