如何记录 JavaScript/CoffeeScript 数据结构

Question

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

例如，什么是一个好方法来判断所使用的变量 distance 是一个长度为 i 和 j 的二维数组，并存储 -1 和 -1 之间的数字强>MAX_INT。我可以想到这样的事情：

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

对于某些数据类型来说，用作 ma​​p/dictionary 的对象怎么样？二维数组怎么样，其中数组的第一个元素定义其他数据 。

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

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 调用它。

Answer 2

当我复制大量数据模型时，我倾向于在 JavaScript 中做的就是在注释中写出它们的类定义。我不确定这是否是你的问题的意思。

// JavaScript Class jsHomeLocation
// jsHomeLocation{
// string name
// string address
// }

var jsHomeLocation = {};
jsHomeLocation.name = "Travis";
jsHomeLocation.address = "California";

您还可以使用javascript对象来跟踪示例的信息，二维数组

var distanceData = {};
distanceData.type = "two-dimensional array";
distanceData.length = i * j;
distanceData.min = -1;
distanceData.max = MAX_INT;