General - Google 风格指南中文版

通用指南

注释

JSON 对象中不使用注释。

JSON 对象中不应包含注释。本风格指南中的某些示例包含注释，但这仅用于阐明示例。


// 反面示例
 
{
  // 你可能会在下面的示例中看到注释，
  // 但不要在你的 JSON 中包含注释。
  "propertyName": "propertyValue"
}

双引号

使用双引号。

如果属性需要引号，必须使用双引号。所有属性名必须用双引号包围。字符串类型的属性值必须用双引号包围。其他值类型（如布尔值或数字）不应用双引号包围。

扁平数据 vs 结构化层次

数据不应为了方便而随意分组。

数据元素在 JSON 表示中应该是”扁平化”的。数据不应为了方便而随意分组。在某些情况下，例如表示单一结构的属性集合，保持结构化层次可能更合理。这些情况应仔细考虑，仅在语义上有意义时使用。例如，地址可以用两种方式表示，但结构化方式对开发者来说可能更合理：

扁平化地址：


{
  "company": "Google",
  "website": "https://www.google.com/",
  "addressLine1": "111 8th Ave",
  "addressLine2": "4th Floor",
  "state": "NY",
  "city": "New York",
  "zip": "10011"
}

结构化地址：


{
  "company": "Google",
  "website": "https://www.google.com/",
  "address": {
    "line1": "111 8th Ave",
    "line2": "4th Floor",
    "state": "NY",
    "city": "New York",
    "zip": "10011"
  }
}