【问题标题】:Naming conventions for JSON-serializable variablesJSON 可序列化变量的命名约定
【发布时间】:2016-06-30 21:36:35
【问题描述】:

人们对保存 JSON 可序列化对象的变量使用什么命名约定?我们希望变量的名称能够提醒我们只在对象中存储可以序列化为 JSON 而不会丢失信息的信息。应用程序包括 HTTP 会话、不可搜索的数据库列、数据记录和序列化可恢复的应用程序状态。

明显的竞争者,至少从使用 Javascript 为 node.js 编程的人的角度来看,似乎不足:

  • prefixJSON - JSON 实际上是一种序列化语法,所以这个 应该是 JSON 格式的字符串,而不是对象
  • prefixInfo - info 经常在 node.js 中用于任何类型的地图, 包括那些采用 ES6 类的函数和实例的。
  • prefixMap - 与info 后缀相同的问题
  • prefixData - 并没有真正建议对类型进行限制

我能做的最好是prefixJSONInfoprefixJSONDataprefixJSONObject,但我希望得到更简洁易读的东西。前缀也可能很长且具有描述性。

这个问题主要适用于支持变体类型变量的编程语言,例如Javascript。这些变量是用来保存杂乱无章的,但需要提醒程序员限制放入杂乱无章的值的类型。

【问题讨论】:

  • 不要与 JSON 对象的组成值的命名约定混淆,此处解决:stackoverflow.com/questions/5543490/json-naming-convention
  • 我找到了几个使用类名 JSONObject 和 JSONArray 的强类型语言库。这些似乎是两种最常见的 JSON 序列化类型的标准名称。
  • 整个网络的示例代码中有一个奇怪的现象,将变量设置为new JSONObject():这些变量中的大多数都被命名为“object”或“obj”。类的所有实例都是对象,但被标记为“对象”类型的是 JSONObject 实例。我看到变量名objectobjjsonObjectjsonObj,甚至只是jo

标签: javascript json variables naming-conventions


【解决方案1】:

在这种情况下,特定的首字母缩略词似乎可以起到很好的作用。

JS开启S可序列化

书面:

JSSJss

例子:

前缀Jss

customerDataJss

sessionInfoJss

甚至可能:

JSONS可序列化Object

前缀JSO

prefixJso

我的 0.02 美元。这可能更多地基于意见,因为我认为这些事情没有任何全球公认的标准。有一些最佳实践,例如您提到的(例如简短但具有描述性)。由开发人员或团队决定他们喜欢哪些简短的描述性版本(团队偏好)。

相信我,我理解有时命名事物是多么困难。 :)

【讨论】:

  • 嘿,我喜欢这个!也许我们需要按照您的提议创建一个约定。非标准的后缀肯定会导致程序员停顿。我也会给其他人一些时间来权衡。谢谢!
  • 顺着这些思路,JSON 代表 JavaScript Object Notation,所以在我们序列化为符号之前,我们有一个 JavaScript Object,或 JSO。有几种方法可以使 JSO 工作,使其成为强有力的候选者。太棒了!
  • JSObj 可能是最好的方法。它体现了 JSO 的各种含义,同时也具有暗示性。如果没有 N,JSO 无法完全识别。请参阅我的 OP 评论,了解整个网络中的代码似乎表明 JSON 对象属于“对象”类型。
猜你喜欢
  • 2017-04-03
  • 2021-07-29
  • 1970-01-01
  • 2016-08-26
  • 1970-01-01
  • 1970-01-01
  • 2010-09-19
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多