Недопустимый шаблон JSON (JSON001)
| Свойство | Значение |
|---|---|
| Идентификатор правила | JSON001 |
| Заголовок | Недопустимый шаблон JSON |
| Категория | Стиль |
| Подкатегории | Н/П |
| Применимые языки | C#, Visual Basic |
| Параметры | См . раздел "Параметры ". |
Обзор
Это правило помечает, где строка литерала JSON не соответствует требуемому синтаксису. Правило применяется к определенному JSON, которое определяется включением в строковый комментарий или комментариев, предшествующих строке JSON, например //lang=json или//lang=json,strict. Последний комментарий использует строгий режим для интерпретации JSON.
Это правило доступно только для интегрированной среды разработки и не применимо для сценариев командной строки.
Параметры
Параметры указывают поведение, которое требуется применить правило.
Для кода, распознанного как JSON, можно задать параметры в Visual Studio, выбрав "Параметры инструментов>>" текстового редактора>C# | Visual Basic>Advanced. Следующие параметры доступны в разделе строк JSON:
| Свойство | Description |
|---|---|
| Цвет строк 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
Дополнительные сведения см. в разделе Практическое руководство. Скрытие предупреждений анализа кода.