不合法的 JSON 模式 (JSON001)
屬性 | 值 |
---|---|
規則識別碼 | JSON001 |
職稱 | 無效的 JSON 模式 |
類別 | 樣式 |
子類別 | N/A |
適用語言 | C#、Visual Basic |
選項 | 請參閱 選項 一節。 |
概觀
此規則旗標會放置 JSON 常值字串不符合必要語法的位置。 此規則適用於已識別的 JSON,這是由包含 JSON 字串前面的內嵌批註或批註所決定,例如 //lang=json
或 //lang=json,strict
。 後者的批註會使用嚴格模式進行 JSON 解譯。
此規則僅供 IDE 使用,不適用於命令行案例。
選項。
選項會指定您希望規則強制執行的行為。
針對辨識為 JSON 的程式代碼,您可以選取 [工具>選項>] 文本編輯器>C# | Visual Basic>[進階],在 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
如需詳細資訊,請參閱 如何隱藏程式代碼分析警告。