如何记录JavaScript/CoffeeScript数据结构

Question

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

例如,一个好的方法可以告诉我,使用的变量距离是一个长度为i和j的二维数组,并存储-1和MAX_INT之间的数字.我能想到这样的事情:

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

如何将某个对象用作某些数据类型的映射/字典,二维数组怎么样,其中数组的第一个元素定义其他数据,然后是其余数据等.

当然,我总是可以在文本中记录这些内容,我只是想到,也许有一种众所周知的方法以半正式方式执行此操作.

Answer 1

尽管它还没有被广泛采用（还？），但有一个JSON 模式标准草案。我只是自己学习，但是您可以为二维数组（包装在对象内部）编写一个架构，如下所示：

{
    "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 验证器的列表。我正在使用规范作者编写的一个名为（足够简单）的json-schema，并且我非常喜欢从 CoffeeScript 调用它。