É possível fazer comentários em JSON

Usamos JSON para muitas aplicações atualmente, mas será que podemos fazer comentários dentro de um JSON?

Esse é o formato de comunicação mais comum entre APIs, é a base para a criação de objetos e também é o formato de comunicação com alguns bancos de dados NOSQL, como o MongoDB.

Frequentemente, quando estamos desenvolvendo, precisamos fazer algum tipo de comentário em nossos arquivos para documentar o que aquilo significa ou então nos lembrar de algo que ainda precisa ser feito.

No entanto, se você tentar simplesmente fazer um comentário em seu editor de texto em um arquivo JSON, verá que aparecerá um erro.

comentário no json

Então, será que podemos fazer um comentário?

É possível fazer um comentário no JSON?

Para simplificar, não! Não é possível.

JSON é um formato que deve ser composto apenas por dados. Isto é, qualquer outro tipo de informação que não seja no formato: nome -> valor.

Mas então como fazer para documentar um JSON ou colocar nossos famosos TODO: para futuras modificações?

Bom, existem algumas maneiras de você trabalhar com isso. A primeira delas é mais simples:

Basta você utilizar as áreas da aplicação que geram ou chamam seu JSON e adicionar seus comentários logo acima dessa chamada.

Outra maneira interessante, mas que vai aumentar um pouquinho o tamanho de seus objetos e documentos JSON é adicionar uma entrada chama "_comentario", ou "_comment" ou com algum nome que faça sentido para você. Exemplo:

{
    "_comentario": "Aqui vai o seu comentário sobre esse JSON",
    "propriedade": "valor",
    "propriedade 3": [
        {
            "prop1": "valor 1",
            "prop2": "valor 2"
        },
        {
            "prop3": "valor 1",
            "prop4": "valor 2"
        }
    ]
}

Ao fazer isso, você poderá destacar o que necessita comentar em seu JSON ao mesmo tempo que não precisa utilizar essa informação na sua aplicação.

Ao fazer uma requisição desse JSON, pode simplesmente ignorar essa propriedade.

Quero comentar no meu JSON de qualquer jeito. O que posso fazer?

Caso você não goste das alternativas acima e queria dar um jeitinho para comentar no seu JSON, há também outras pessoas que estão no mesmo barco que você.

Inclusive, um desenvolvedor criou uma solução chamada JSON.minify. E também achei um outro sujeito que desenvolveu uma solução similar que tem uma performance um pouco melhor. Confira nos links acima!

O grande lance dessas soluções é que você pode criar o seu JSON com comentários normalmente. Seu editor de texto provavelmente vai acusar o erro, mas você pode ignorá-lo já que tem algo no seu código que vai te ajudar.

Para implementar essa solução, utilize o código dos repositórios acima e, ao chamar seu JSON, o faça da seguinte maneira:

JSON.parse(JSON.minify(my_str));

O que essa função faz é passar por um processo de remoção de comentários e de espaços vazios antes de ser chamado para sua aplicação.

Pessoalmente, não é algo que eu utilizaria pois prefiro deixar meu código mais simples, mas entendo que há pessoas que poderiam se interessar mais por essa opção.

Conclusão

O propósito do JSON é armazenar dados e proporcionar uma maneira de troca de dados entre aplicações. Por isso, o uso de comentários dentro dele não é possível.

O que você achou dessa explicação? Há algo mais que considere importante ser mencionado? Deixe nos comentários.

Divirta-se!

Gostou do artigo?

Share on facebook
Facebook
Share on linkedin
LinkedIn
Share on pinterest
Pinterest
Share on whatsapp
WhatsApp
André Lug

André Lug

Apaixonado por design e desenvolvimento de websites. De vez em quando gosta de escrever sobre produtividade, como é ser um freelancer e algumas reflexões da vida.

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *