Ungültiges JSON-Muster (JSON001)
| Eigenschaft | Wert |
|---|---|
| Regel-ID | JSON001 |
| Titel | Ungültiges JSON-Muster |
| Kategorie | Stil |
| Unterkategorie | Nicht zutreffend |
| Gültige Sprachen | C#, Visual Basic |
| Optionen | Siehe Abschnitt "Optionen ". |
Übersicht
Diese Regel kennzeichnet Orte, an denen eine JSON-Literalzeichenfolge nicht der erforderlichen Syntax entspricht. Die Regel gilt für identifiziertes JSON, das durch die Einbeziehung eines In Zeilenkommentar oder Kommentars vor der JSON-Zeichenfolge bestimmt wird, z//lang=json. B. oder //lang=json,strict. Der letzte Kommentar verwendet den strengen Modus für die JSON-Interpretation.
Diese Regel ist nur IDE und gilt nicht für Befehlszeilenszenarien.
Optionen
Optionen geben das Verhalten an, das die Regel erzwingen soll.
Für Code, der als JSON erkannt wird, legen Sie die Optionen in Visual Studio fest, indem Sie "Extras>Optionen>Text Editor>C# | Visual Basic>Advanced" auswählen. Die folgenden Optionen stehen im Abschnitt mit JSON-Zeichenfolgen zur Verfügung:
| Eigenschaft | Beschreibung |
|---|---|
| Färben von JSON-Zeichenfolgen | Gibt an, ob JSON-Zeichenfolgen gefärbt werden sollen. |
| Ungültiger JSON-Bericht | Gibt an, ob ungültiger JSON-Code angegeben werden soll. |
| Hervorheben verwandter Komponenten unter dem Cursor | Gibt an, ob Quick Actions Hervorhebungen verwendet. |
Beispiel
Der folgende Codeausschnitt zeigt ein Beispiel mit ungültiger JSON.The following code snippet shows an example with invalid 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]
}
""";
Unterdrücken einer Warnung
Um nur eine einzelne Verletzung zu unterdrücken, fügen Sie der Quelldatei Präprozessoranweisungen hinzu, um die Regel zu deaktivieren und dann wieder zu aktivieren.
#pragma warning disable JSON001
// The code that's violating the rule is on this line.
#pragma warning restore JSON001
Um die Regel für eine Datei, einen Ordner oder ein Projekt zu deaktivieren, legen Sie den Schweregrad in der Konfigurationsdatei auf none fest.
[*.{cs,vb}]
dotnet_diagnostic.JSON001.severity = none
Weitere Informationen finden Sie unter Vorgehensweise: Unterdrücken von Codeanalyse-Warnungen.