我一直想知道是否存在命名数据键的“最佳实践”,或许更重要的是,是否有任何标准方法来命名这些条目。
我见过的大多数格式都与以下内容类似或不同:
datakeyone
dataKeyOne
data-key-one
data_key_one
但是有没有标准或推荐的方法,如果没有(或者有多种方法),每种方法的优点和缺点是什么?
答案 0 :(得分:1)
一般一致命名是最重要的事情 - 无论您采用或创建什么标准,只有严格使用它才有价值。
之后,基本的东西,如好的,未缩写的,正确拼写的有意义的名称是关键。我会避免使用连字符,破折号,空格,数字,下划线和特殊字符 - 它们只是添加到名称长度而不提供任何好处。
如果可能,您应该使用名称来表达数据类型。在您的示例中,数据键一,但是您编写它并不意味着什么 - 确保名称有意义与一致性一样重要。
骆驼套管名称是一种很好的做法,只要它一直被使用 - 一个简单的规则,如“只用大写字母”写出每个术语中的第一个字符是好的。它是可读的,它显示了中断,而不需要任何其他字符。
作为首字母缩略词或首字母缩写词的术语应使用全部大写字母 - 除非它们长度超过两个字母,在这种情况下它们应使用标准的骆驼套管。
虽然这些规则不是任何标准的一部分,但它们是可靠的,并且应该在您提到的语言中正常工作。
以下是使用上述规则的一些示例,以及显示优缺点的注释......
应该避免坏键:
GoodKeys:使用上述规则