5 JSON Coding Convention
b24hugst edited this page 2026-05-15 09:53:27 +00:00

JSON Coding Convention

Naming conventions

  • Variables and attributes should, for this project, be named using camelCase.
  • Each name should also be descriptive. Names like "Green213123" are not valid, while names such as "carOwner" are.

Syntax

Containers and arrays

In JSON, each document must be contained within either a pair of "{" or "[" characters.

  • "{}": means that whatever is inside it is an object (unordered key/value pairs).
{
   "firstName": "Sven",
   "sirName": "Svensson"
}
An important detail to note is the presence of the "," character at the end of all but the last item pair.
The character signals to JSON when to start the next item, or, in other words, a metaphorical line break.
  • "[]": means that whatever is inside is part of a collection (an array).

[
   "apple", 
   "banana"
]


DataTypes

Inside JSON are INTS and Strings, the two primary datatypes. From a pure syntax standpoint, the only difference between the two is the presence of quats or not.

{
    "string": "value",
    "int": 123
}

Important to note is that if a non-integer value is syntactically given as a string, an error will be thrown.

{
    "int":  This-will-make-an-error
}

JSON also has support for the less common null-value and Boolean values true and false.

{
    "bolean-false": false,
    "bolean-true": true,
    "null-value": null 
}

Nesting

One of the most important features of JSON is the ability to nest arrays and collections within one another to create complexer structures to represent some data.

{
  "menu": {
    "id": 1,
    "value": "value",
    "popup": {
      "menuitem": [
        {
          "value": "New",
          "onclick": "CreateNewDoc()"
        },
        { "value": "Open", "onclick": "OpenDoc()" },
        { "value": "Close", "onclick": "CloseDoc()" }
      ]
    }
  }
}