偵測到可能的 JSON 字串 (JSON002)

屬性
規則識別碼 JSON002
職稱 偵測到可能的 JSON 字串
類別 樣式
子類別 N/A
適用語言 C#、Visual Basic
選項 N/A

概觀

此規則旗標會放置偵測到 JSON 常值字串,但未明確識別的位置。 JSON 是使用 JSON 字串前面的內嵌批注或批注來識別,例如 //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

如需詳細資訊,請參閱 如何隱藏程式代碼分析警告

另請參閱