Patrón JSON no válido (JSON001)

  • Artículo
Propiedad Value
Identificador de la regla JSON001
Título Patrón JSON no válido
Categoría Estilo
Subcategoría N/D
Lenguajes aplicables C#, Visual Basic
Opciones Consulte la sección Opciones .

Información general

Esta regla marca lugares donde una cadena literal JSON no se ajusta a la sintaxis necesaria. La regla se aplica a JSON identificado, que viene determinado por la inclusión de un comentario en línea o comentario anterior a la cadena JSON, como //lang=json o //lang=json,strict. Este último comentario usa el modo strict para la interpretación de JSON.

Esta regla es solo IDE y no es aplicable a escenarios de línea de comandos.

Opciones

Las opciones especifican el comportamiento que se quiere que aplique la regla.

Para el código reconocido como JSON, establezca las opciones en Visual Studio seleccionando Herramientas>Opciones>del Editor>de texto C# | Visual Basic>Avanzado. Las siguientes opciones están disponibles en la sección Cadenas JSON:

Propiedad Descripción
Colorear cadenas JSON Especifica si se deben colorear las cadenas JSON.
Notificar JSON no válido Especifica si se va a notificar json no válido.
Resaltar componentes relacionados en el cursor Especifica si acciones
rápidas usa resaltado.

Ejemplo

En el fragmento de código siguiente se muestra un ejemplo con JSON no válido.

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

Supresión de una advertencia

Si solo quiere suprimir una única infracción, agregue directivas de preprocesador al archivo de origen para deshabilitar y volver a habilitar la regla.

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

Para deshabilitar la regla de un archivo, una carpeta o un proyecto, establezca su gravedad en none del archivo de configuración.

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

Para obtener más información, consulte Procedimiento para suprimir advertencias de análisis de código.

Consulte también