Se você está com problemas para adicionar comentários ao seu arquivo JSON, há um bom motivo: o JSON não suporta comentários.

“Eu removi os comentários do JSON porque vi que as pessoas os estavam usando para manter diretivas de análise, uma prática que destruiria a interoperabilidade”, de acordo com Douglas Crockford, que popularizou o formato de dados baseado em texto.

No entanto, há uma solução alternativa. E é disso que trata este artigo: como adicionar comentários ao seu arquivo JSON.

Uma maneira de contornar o problema dos comentários é adicionar dados ao seu arquivo JSON que funcionam como comentários.

Vamos dar um exemplo, começando com essas informações em nosso arquivo JSON.

{   "sport": "basketball",   "coach": "Joe Smith",   "wins": 15,   "losses": 5}

Agora, vamos adicionar outro par de valores-chave para servir como nosso comentário, que você pode ver na primeira linha do código abaixo.

{   "_comment1": "this is my comment",   "sport": "basketball",   "coach": "Joe Smith",   "wins": 15,   "losses": 5}

Aqui está outro exemplo. Desta vez, usamos dois sublinhados no início e no final da chave.

 "__comment2__": "this is another comment",

Usamos os sublinhados para diferenciar o comentário do restante dos dados em nosso arquivo.

Uma palavra de cautela

Há um detalhe importante a ser lembrado.

Os comentários que adicionamos ao nosso arquivo JSON estão incluídos no objeto JSON. Em outras palavras, os comentários são tratados como dados.

Aqui está o que queremos dizer.

Este é o código em nosso arquivo, data.json:

{   "_comment1": "this is my comment",   "sport": "basketball",   "coach": "Joe Smith",   "wins": 15,   "losses": 5}

Agora vamos ler esses dados do arquivo, read_comments.py:

import jsonwith open("data.json", mode="r") as j_object:   data = json.load(j_object)print(data)

O resultado inclui nosso comentário.

{'_comment1': 'this is my comment', 'sport': 'basketball', 'coach': 'Joe Smith', 'wins': 15, 'losses': 5}

Podemos até extrair o valor do comentário do objeto JSON: this is my comment.

import json with open("data.json", mode="r") as j_object:   data = json.load(j_object)   print(data["_comment1"])

Lembre-se de que o comentário é apenas um comentário aos olhos do desenvolvedor, não do computador.

Essa prática de comentários JSON é diferente dos comentários em linguagens de programação, como Python, que geralmente são ignoradas quando o programa é executado.

# Here's my commentword = "house"for letter in word:   print(letter)

Quando executamos o programa Python acima, obtemos as letras na palavra “casa”. Mas não vemos o comentário. Isso é ignorado.

JSMin é outra opção a considerar.

É uma ferramenta que remove espaço em branco extra e comentários dos arquivos JavaScript. Mas também funciona em arquivos JSON. O JSMin remove comentários dos arquivos JSON antes de serem analisados.

Portanto, existem opções quando se trata de comentar em arquivos JSON. Embora não sejam soluções perfeitas, pelo menos existem maneiras de incluir a documentação que você precisa quando precisa.

Escrevo sobre aprender a programar e as melhores maneiras de fazer isso (amymhaddad.com)



Fonte