Provável cadeia de caracteres JSON detectada (JSON002)
| Propriedade | Valor |
|---|---|
| ID da regra | JSON002 |
| Título | Provável cadeia de caracteres JSON detectada |
| Categoria | Estilo |
| Subcategoria | N/D |
| Linguagens aplicáveis | C#, Visual Basic |
| Opções | N/D |
Visão geral
Essa regra sinaliza locais onde uma cadeia de caracteres literal JSON é detectada, mas não é explicitamente identificada. JSON é identificado usando um comentário embutido ou comentário que precede a cadeia de caracteres JSON, como //lang=json ou //lang=json,strict. O último comentário usa o modo estrito para interpretação JSON.
Essa regra pode não ser sinalizada no editor se as opções do editor JSON estiverem habilitadas em Opções>de Ferramentas>Editor>de Texto C# | Visual Basic>Advanced>JSON strings.
Essa regra é somente IDE e não é aplicável a cenários de linha de comando.
Opções
Esta regra não suporta quaisquer opções. Para obter as opções disponíveis para configurar no IDE quando JSON é especificado, consulte Padrão JSON inválido (JSON001).
Exemplo
O trecho de código a seguir mostra um exemplo em que uma provável cadeia de caracteres JSON pode ser detectada.
// Code with violations
var v = """{ "pie": true, "cherry": [1, 2, 3] }""";
// Fixed code
// lang=json,strict
var v = """{ "pie": true, "cherry": [1, 2, 3] }""";
// Fixed code
var v = /*lang=json,strict*/ """{ "pie": true, "cherry": [1, 2, 3] }""";
Suprimir um aviso
Se você quiser suprimir apenas uma violação, adicione diretivas de pré-processador ao arquivo de origem para desabilitar e, em seguida, reabilite a regra.
#pragma warning disable JSON002
// The code that's violating the rule is on this line.
#pragma warning restore JSON002
Para desabilitar a regra em um arquivo, uma pasta ou um projeto, defina a severidade como none no arquivo de configuração.
[*.{cs,vb}]
dotnet_diagnostic.JSON002.severity = none
Para obter mais informações, confira Como suprimir avisos de análise de código.