Neplatný vzor JSON (JSON001)

  • Článek
Vlastnost Hodnota
ID pravidla JSON001
Název Neplatný vzor JSON
Kategorie Styl
Podkategorie –
Příslušné jazyky C#, Visual Basic
Možnosti Viz část Možnosti .

Přehled

Toto pravidlo označí místa, kde řetězec literálu JSON neodpovídá požadované syntaxi. Pravidlo se vztahuje na identifikovaný JSON, který je určen zahrnutím vloženého komentáře nebo komentáře před řetězcem JSON, například //lang=json nebo //lang=json,strict. Druhý komentář používá pro interpretaci JSON striktní režim.

Toto pravidlo je pouze integrované vývojové prostředí (IDE) a neplatí pro scénáře příkazového řádku.

Možnosti

Možnosti určují chování, které má pravidlo vynutit.

Pro kód rozpoznaný jako JSON nastavíte možnosti v sadě Visual Studio tak, že vyberete Editor možností>nástroje>v textovém editoru>C# | Visual Basic>Advanced. V části Řetězce JSON jsou k dispozici následující možnosti:

Vlastnost Popis
Obarvení řetězců JSON Určuje, jestli se mají obarvit řetězce JSON.
Sestava je neplatná ve formátu JSON Určuje, jestli se má hlásit neplatný JSON.
Zvýraznění souvisejících komponent pod kurzorem Určuje, jestli rychlé akce
používají zvýraznění.

Příklad

Následující fragment kódu ukazuje příklad s neplatným kódem 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]
}
""";

Potlačení upozornění

Pokud chcete potlačit pouze jedno porušení, přidejte do zdrojového souboru direktivy preprocesoru, abyste pravidlo zakázali a znovu povolili.

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

Pokud chcete pravidlo pro soubor, složku nebo projekt zakázat, nastavte jeho závažnost v none konfiguračním souboru.

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

Další informace naleznete v tématu Jak potlačit upozornění analýzy kódu.

Viz také