Modèle JSON non valide (JSON001)

  • Article
Propriété Value
Identificateur de la règle JSON001
Titre Modèle JSON non valide
Catégorie Style
Sous-catégorie S.O.
Langages applicables C#, Visual Basic
Options Consultez la section Options .

Vue d’ensemble

Cette règle signale les emplacements où une chaîne littérale JSON n’est pas conforme à la syntaxe requise. La règle s’applique au json identifié, qui est déterminé par l’inclusion d’un élément in commentaire de ligne ou d’un commentaire précédant la chaîne JSON, par //lang=json exemple ou //lang=json,strict. Ce dernier commentaire utilise le mode strict pour l’interprétation JSON.

Cette règle est ide uniquement et non applicable pour les scénarios de ligne de commande.

Options

Les options spécifient le comportement que vous souhaitez que la règle applique.

Pour le code reconnu comme JSON, vous définissez les options dans Visual Studio en sélectionnant Outils>Options>Text Editor>C# | Visual Basic>Advanced. Les options suivantes sont disponibles sous la section chaînes JSON :

Propriété Description
Coloriser des chaînes JSON Spécifie s’il faut coloriser des chaînes JSON.
Signaler un JSON non valide Spécifie s’il faut signaler un JSON non valide.
Mettre en surbrillance les composants associés sous le curseur Spécifie si les actions
rapides utilisent la mise en surbrillance.

Exemple

L’extrait de code suivant montre un exemple avec JSON non valide.

// 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]
}
""";

Supprimer un avertissement

Si vous voulez supprimer une seule violation, ajoutez des directives de préprocesseur à votre fichier source pour désactiver et réactiver la règle.

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

Pour désactiver la règle sur un fichier, un dossier ou un projet, définissez sa gravité sur none dans le fichier de configuration.

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

Pour plus d’informations, consultez Comment supprimer les avertissements de l’analyse de code.

Voir aussi