Как писать комментарии в JSON-файле? Некоторых аналитиков этот вопрос приводит в замешательство, и они либо признаются сразу, что не знают/не помнят, либо начинают что-то сочинять на ходу :) Кто-то при этом может вспомнить про экранирование спец-символов.

На самом деле формат JSON не предусматривает добавление комментариев. JSON - это только данные.

Для чего нужны комментарии? - Чтобы объяснить вещи, которые могут быть не очевидными.

Если вам очень хочется добавить некий комментарий в JSON, то в этом случае нужно добавить дополнительные данные в одном из поддерживаемых форматов. Например, добавить в структуру JSON дополнительный параметр, назвав его "_comment" (или как-то иначе), а значение этого параметра как раз и будет текстом комментария:

 

{
    "_comment": "Это текст комментария - ниже представлен фрагмент базы данных светотехнического оборудования ВПП аэродрома",
    "airport": {
        "icao": "AT27",
        "name": "Troll Airfield",
        "cityName": "Troll",
        "iataCode": "QET",
        "runways": [{
            "runway": {
                "id": "RW07",
                "lightsPilotControlled": false,
                "markingsType": "NSTD",
                "approachLightsRAIL": false,
                "approachLightsLenght": 800,
                "runwayLights": {
                    "thresholdREIL": false,
                    "type": "",
                    "intensity": "",
                    "note": ""
                }
            }
        }, {
            "runway": {
                "id": "RW25",
                "lightsPilotControlled": false,
                "markingsType": "NSTD",
                "approachLightsRAIL": false,
                "approachLightsLenght": 800,
                "runwayLights": {
                    "thresholdREIL": false,
                    "type": "",
                    "intensity": "",
                    "note": ""
                }
            }
        }]
    }
}

Соответственно, все приложения, использующим данные этого JSON, должны игнорировать этот параметр.

Минус данного подхода: не возможно написать комментарий для определенных параметров структуры JSON, только некий общий.

 

Типы данных JSON

В JSON значения могут быть следующих типов:

• строка
• число
• объект (объект JSON)
• массив
• boolean
• null

1. Строка

{

"document": "Do-200A",

"publisher": "RTCA"

}

2. Число - целое или дробное

{

"amount": 100,

"cost": 208.99

}

3. Объект

{
    "airport": {
        "icao": "AT27",
        "iata": "QET",
        "name": "Troll Airfield"
    }
}

 4. Массив

 
{
    "name": "John",
    "hasCars": [
        "Audi",
        "Mitsubishi",
        "ВАЗ 2109"
    ]
}

5. Логическое значение (boolean)

{
    "name": "John",
    "isBoy": true,
    "haveCar": false
}

6. Null

 
{
    "type": "B747",
    "crew": 2,
    "navigator": null
}

 Тип данных NULL условно считается отдельным типом данных. В некоторых источниках он определен, как тип, в некоторых - нет.

Значения JSON не могут быть следующих типов:

• функция
• дата
• undefined