JSON可序列化变量的命名约定

时间:2016-06-30 21:36:35

标签: javascript json variables naming-conventions

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

显而易见的竞争者,至少从某人使用Javascript for node.js进行编程的角度来看,似乎不足:

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

我能做的最好的事情是prefixJSONInfoprefixJSONDataprefixJSONObject,但我希望能提供更简洁,更易读的内容。前缀可能很长且也是描述性的。

这个问题主要适用于支持变体类型变量的编程语言,例如Javascript。这些变量意味着存在混乱,但需要提醒程序员限制投入混杂的值的类型。

1 个答案:

答案 0 :(得分:1)

在这种情况下,似乎特定的首字母缩略词可能有用。

<强> JS 打开的取值 erializable

写为:

JSS Jss

示例:

prefixJss

customerDataJss

sessionInfoJss

或者甚至可能:

<强>Ĵ SON <强>取值 erializable的 0 bject

prefixJSO

prefixJso

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

相信我,我知道有时候命名有多困难。 :)