Naming conventions 命名数据键的最佳实践是什么?

Naming conventions 命名数据键的最佳实践是什么?,naming-conventions,Naming Conventions,我一直想知道是否有命名数据键的“最佳实践”,也许更重要的是,是否有命名这些项的标准方法 我所看到的大多数格式类似于以下格式或其变体: datakeyone dataKeyOne 数据键一 data\u key\u one 但是是否有任何标准或推荐的方法,如果没有(或者有多种),每种方法的优缺点是什么?一般来说,一致的命名是最重要的事情-无论您采用或创建什么标准,只有严格使用,才有价值 在这之后,一些基本的东西,如好的、未加修饰的、拼写正确的有意义的名字是关键。我会避免使用连字符、破折号、空格

我一直想知道是否有命名数据键的“最佳实践”,也许更重要的是,是否有命名这些项的标准方法

我所看到的大多数格式类似于以下格式或其变体:

  • datakeyone
  • dataKeyOne
  • 数据键一
  • data\u key\u one
但是是否有任何标准或推荐的方法,如果没有(或者有多种),每种方法的优缺点是什么?

一般来说,一致的命名是最重要的事情-无论您采用或创建什么标准,只有严格使用,才有价值

在这之后,一些基本的东西,如好的、未加修饰的、拼写正确的有意义的名字是关键。我会避免使用连字符、破折号、空格、数字、下划线和特殊字符——它们只会增加名称长度,而不会带来任何好处

如果可能,您应该用名称表示数据类型。在您的示例中,data key one(数据键1),不管您如何编写它,它并不意味着什么——确保名称有意义与一致性同样重要

驼峰式大小写名称是一种良好的做法,只要它一直被使用——一个简单的规则,如“每个术语中只写第一个大写字母”是很好的。它是可读的,并且不需要任何其他字符就可以在术语中显示中断

首字母缩写或首字母缩略词应使用所有大写字母,除非长度超过两个字母,在这种情况下,应使用标准的驼色大小写

虽然这几条规则不是任何标准的一部分,但它们是可靠的,在您提到的语言中应该可以很好地工作

这里有几个例子使用上面的规则和注释来说明优点和缺点

坏键:应该避免

  • 数据键一(好的,我有数据键一…但什么是数据键一!?)
  • HTTPAddress(HTTPA序列难以读取,术语不清楚)
  • CustomerId(Id不应像这样用驼峰形大小写)
  • 用户性别变更(是“用户性别变更”还是“用户交换”…)
  • AddressLine1(使用数字可能会导致混淆,第1行是什么-房屋名称、街道名称?)
GoodKeys:使用上述规则

  • FinalScore(哦,那个!数据键一是高分!)
  • HttpAddress(可读性更强,术语更清晰)
  • CustomerID(因为我们需要一个标识符,而不是对客户的引用)
  • UsersExchanged(呸!)
  • AddressStreetName(更清楚的是,我们甚至不需要一个名称更有意义的数字)

哪种语言、规格?有很多标准!具体来说,我现在对Python和HTML5的Web存储和IndexedDB感兴趣。我不同意这个答案中的所有内容,但这是一个好答案+1.如果我能为整洁的“usersexchanged”示例再做一次+1,我会的!:)