javascript - 如何记录 JavaScript/CoffeeScript 数据结构

Question

我正在寻找一种描述性的方式来记录我的 JavaScript 应用程序中使用的数据结构。由于 JavaScript 的动态特性，我发现很难完成这项工作。

例如，使用变量distance 是一个长度为 i 和 j 的二维数组，存储的数字介于 -1 之间，这可能是个好方法> 和 MAX_INT。我可以想到这样的事情:

distance[i][j] = -1 <= n <= MAX_INT

用作某些数据类型的 map /字典的对象，二维数组，其中数组的第一个元素定义其他数据，然后是其余数据，等等。

当然，总是可以在文本中记录这些事情，我只是想，也许有一种众所周知的和常用的方式以半正式的方式来做到这一点。

Answer 1

虽然它还没有被广泛采用(还没有？)，但有一个 draft standard for JSON schema .我只是自己学习，但您可以为二维数组(包裹在对象内部)编写一个架构，如下所示:

{
    "description":"Two dimensional array of numbers",
    "type":"object",
    "properties":{
        "two-d-array":{
            "description":"columns",
            "type":"array",
            "items":{
                "description":"rows",
                "type":"array",
                "items": {
                   "description":"values",
                   "type":"number",
                   "minimum":-1,
                   "maximum":Number.MAX_VALUE
                }
            }
        }
    }
}

或者简单地说:

{
    "type":"array",
    "items":{
        "type":"array",
        "items": {
            "type":"number",
            "minimum":-1,
            "maximum":Number.MAX_VALUE
        }
    }
}

据我所知，没有 CoffeeScript 实现，但有几个 JavaScript 验证器的列表 here .我正在玩由规范作者编写的名为(足够简单)json-schema 的规范。我非常喜欢从 CoffeeScript 调用它。