记录 JSON 文件结构的最佳实践？

Question

Closed. This question is opinion-based. It is not currently accepting answers.

---

想要改进这个问题？更新问题，以便可以通过编辑这篇文章用事实和引文来回答它。

6 年前已关闭。

Answer 1

JSON 只是数据结构的序列化表示；因此，您应该记录数据结构而不是序列化输出。

/**
 * @var object Customer
 */
var customer = {
    /**
     * @var Number[][]
     */
    "open-orders": [],
    /**
     * @var String[][]
     */
    "terms": []
};

此外，JSON 没有任何数据规范（标记）符号，如 XML；尽管 XML 也可用于序列化数据，但它允许您指定数据的结构（使用 XSD）。 JSON 无意执行此操作，并且没有提供此类机制。

Answer 2

您可以为 json 结构编写架构（就像 XML 文件的 dtd 一样）。

这是一个很好的起点： http://json-schema.org

示例：

{
    "title": "Example Schema",  
    "type": "object",
    "properties": {
        "firstName": {
            "type": "string"
         },
         "lastName": {
             "type": "string"
         },
         "age": {
             "description": "Age in years",
             "type": "integer",
             "minimum": 0
         }
    },
    "required": ["firstName", "lastName"]
}