检测到可能的 JSON 字符串（JSON002）

属性	值
规则 ID	JSON002
标题	可能检测到 JSON 字符串
类别	Style
Subcategory	不可用
适用的语言	C#, Visual Basic
选项	空值

概述

此规则标志用于放置检测到 JSON 文本字符串但未显式标识的位置。 JSON 是通过使用 JSON 字符串前面的 in行注释 或注释来标识的，例如//lang=json或 //lang=json,strict。 后一个注释使用严格模式进行 JSON 解释。

如果在工具>选项>文本编辑器>C# | Visual Basic>高级>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

有关详细信息，请参阅如何禁止显示代码分析警告。

另请参阅

• JSON001