Comments

[cecilemuller]

A question have been recurring:

How to handle comments?

[cecilemuller]

Two ways are possible, depending on whether the comments need to be part of the scenegraph or not.

---

When comments don't need to be part of the scenegraph

They are the same as VRML comments.

You can use a JSON5 parser (for example, the json5 module has 1 million downloads per month) to support familiar Javascript-style comments in JSON:

{
    "$": "Shape",

    // This line is a comment.
    "geometry": {
        "$": "Sphere"
    },

    "appearance": {
        "$": "Appearance",
        "material": {
            "$": "Material",
            "diffuseColor": [0, 1, 0]
        }
    }
}

Example in node.js

---

When comments must be part of the scenegraph:

Use Metadata nodes, for example:

{
    "$": "MetadataString",
    "name": "mydata",
    "value": ["one", "two", "three"]
}

[cecilemuller]

Although, if comments don't need to be in the scenegraph, I would advise to simply not include them to avoid having to use a JSON5 parser.