【发布时间】:2016-06-30 21:36:35
【问题描述】:
人们对保存 JSON 可序列化对象的变量使用什么命名约定?我们希望变量的名称能够提醒我们只在对象中存储可以序列化为 JSON 而不会丢失信息的信息。应用程序包括 HTTP 会话、不可搜索的数据库列、数据记录和序列化可恢复的应用程序状态。
明显的竞争者,至少从使用 Javascript 为 node.js 编程的人的角度来看,似乎不足:
-
prefixJSON- JSON 实际上是一种序列化语法,所以这个 应该是 JSON 格式的字符串,而不是对象 -
prefixInfo-info经常在 node.js 中用于任何类型的地图, 包括那些采用 ES6 类的函数和实例的。 -
prefixMap- 与info后缀相同的问题 -
prefixData- 并没有真正建议对类型进行限制
我能做的最好是prefixJSONInfo、prefixJSONData 或prefixJSONObject,但我希望得到更简洁易读的东西。前缀也可能很长且具有描述性。
这个问题主要适用于支持变体类型变量的编程语言,例如Javascript。这些变量是用来保存杂乱无章的,但需要提醒程序员限制放入杂乱无章的值的类型。
【问题讨论】:
-
不要与 JSON 对象的组成值的命名约定混淆,此处解决:stackoverflow.com/questions/5543490/json-naming-convention
-
我找到了几个使用类名 JSONObject 和 JSONArray 的强类型语言库。这些似乎是两种最常见的 JSON 序列化类型的标准名称。
-
整个网络的示例代码中有一个奇怪的现象,将变量设置为
new JSONObject():这些变量中的大多数都被命名为“object”或“obj”。类的所有实例都是对象,但被标记为“对象”类型的是 JSONObject 实例。我看到变量名object、obj、jsonObject、jsonObj,甚至只是jo。
标签: javascript json variables naming-conventions