JSON (JavaScript Object Notation - Notación de Objeto de JavaScript) es un formato de intercambio de datos popular utilizado en el desarrollo web y aplicaciones móviles debido a su simplicidad y flexibilidad.

Pero los archivos JSON no soportan comentarios oficialmente. Esto hace que proporcionar contexto o explicación adicional para estos datos sea un desafío.

Este artículo te mostrará cómo incluir comentarios en archivos JSON y por qué JSON no admite comentarios de forma nativa.

¿Por qué JSON no soporta comentarios?

Según la especificación JSON, un documento JSON sólo debe contener estructuras de datos como arreglos y objetos y no incluir comentarios. Esto se debe a que JSON pretende ser un formato de datos simple y fácilmente analizable que se pueda procesar de manera rápida y eficiente.

Los comentarios, si bien son útiles para proporcionar contexto o explicación adicional para los humanos, pueden agregar complejidad al proceso de análisis. Esto ralentiza el rendimiento y aumenta el riesgo de errores.

La razón principal por la que JSON no admite comentarios es que su creador, Douglas Crockford, los eliminó deliberadamente del formato para evitar el uso indebido y mantenerlo como un formato exclusivamente de datos.

Crockford observó que algunas personas usaban comentarios para almacenar directivas de análisis, lo que podría romper la compatibilidad entre diferentes sistemas. De ahí la decisión de eliminar los comentarios para mantener la simplicidad y coherencia del formato en varios lenguajes y entornos de programación.

Como resultado, la única opción para agregar comentarios a un archivo JSON es utilizar una solución alternativa, como utilizar elementos personalizados para almacenar comentarios.

¿Cómo agregar comentarios a un archivo JSON?

Cuando agregas comentarios en el formato //, # o /* */, que se utilizan en lenguajes de programación populares, notará el error Comments are not permitted in JSON ("No se permiten comentarios en JSON").

Entonces, ¿cómo puedo agregar comentarios a mi archivo JSON?

La única forma de hacerlo es incluir comentarios como pares de datos en un archivo JSON. No es una práctica comúnmente utilizada ni recomendada, pero técnicamente es la mejor manera de agregar comentarios a su archivo JSON.

Crea un elemento personalizado dentro de tu objeto JSON, como "_comentario", para distinguirlos del resto de los datos.

{
    "_comentario": "escribe acá tu comentario JSON"
    "nombre": "John Doe",
    "edad": 35,
    "ciudad": "New York",
    "esCasado": true,
    "ocupacion": "Ingeniero de Software",
}

Nota: No es obligatorio utilizar guiones bajos. Puedes decidir utilizar dos barras, como “//comentario” o cualquier otro carácter permitido. El objetivo es dejar claro que se trata de un comentario.

Es importante tener en cuenta que este enfoque puede hacer que el archivo JSON sea más complejo y más difícil de analizar. Pero si los comentarios se agregan como elementos personalizados, se recibirán y procesarán como cualquier otro dato en JSON en el lado del servidor.

Ahora sabes técnicamente cómo agregar comentarios a tu archivo JSON. Pero, ¿cómo se pueden agregar varios comentarios? Esto es posible, pero debes recordar que JSON no permite claves de objetos duplicadas. Debe incluir letras o números únicos en el elemento de comentario, asegurándose de que sea válido y distinguible de otros elementos en el archivo JSON.

{
    "_comentario1": "Estos son datos básicos",
    "nombre": "John Doe",
    "edad": 35,
    "ciudad": "New York",
    "_comentario2": "Información marital",
    "esCasado": true,
    "nombreEsposa": "Jane Doe"
}

Cuando tengas objetos JSON anidados, puedes utilizar claves de objetos similares:

{
    "_comentario": "Estos son datos básicos",
    "nombre": "John Doe",
    "edad": 35,
    "ciudad": "New York",
    "informacionMarital": {
        "_comentario": "Información Marital",
        "esCasado": true,
        "nombreEsposa": "Jane Doe"
    }
}

Conclusión

Ahora sabes cómo agregar comentarios a tu archivo JSON. Pero debido a que estos comentarios también se procesan y se puede acceder a ellos, debes tener cuidado al agregar comentarios a archivos JSON utilizando elementos personalizados.

Gracias por leer y feliz codificación.