Reference
Comments
The$comment
keyword is strictly intended for adding comments to aschema. Its value must always be a string. Unlike the annotationstitle
,description
, andexamples
, JSON schemaimplementationsaren't allowed to attach any meaning or behavior to it whatsoever, andmay even strip them at any time. Therefore, they are useful for leavingnotes to future editors of a JSON schema, but should not be used tocommunicate to users of the schema.
data
{"$comment":"Created by John Doe","type":"object","properties":{"country":{"$comment":"TODO: add enum of countries"}}}
Need Help?
Did you find these docs helpful?
Help us make our docs great!
At JSON Schema, we value docs contributions as much as every other type of contribution!
Still Need Help?
Learning JSON Schema is often confusing, but don't worry, we are here to help!.