怎样写好的变量名？

作者: longLiveData | 来源:发表于2020-03-02 10:24 被阅读0次

为什么需要命名规范？

二流程序员写代码给机器看，一流程序员写代码给人看。

为标识符提供附加的信息，赋予标识符现实意义。帮助我们理顺编码的逻辑，减少阅读和理解代码的工作量；
使代码审核变得更有效率，专注于更重要的问题，而不是争论语法和命名规范这类小细节，提高开发效率；
提高代码的清晰度、可读性以及美观程度；
避免不同产品之间的命名冲突。

Java命名规范

java命名规范

取好名字的三条原则

1.要有准确的意义

名字要能够准确、完整地表达出它代表的意义，可以见字知意，名副其实。
比如，表达式“a = b - c”的语法是没有什么问题，可是该表达式代表的实际含义并不清楚。相比而言，“grossIncome = grossRevene - costOfGoodsSold”就有很准确、清晰的现实意义。这样的命名更容易阅读和理解。

严格遵守命名规范

不同的编程环境，偏爱不同的命名规范，比如 Java 倾向于使用驼峰命名法，C 语言倾向于使用蛇形命名法，CSS 使用串式命名法。尽管如此，如果定义了个性化的命名规范，请严格遵守自定义的命名规范，如果没有定义个性化的命名规范，我们就需要严格遵守业界普遍公认的命名规范。

3.可读性优先

-可读性强的名字优先于简短的名字，尽量使用完整的词汇。
-不要使用缩写、简写、缩略词，除非这些词语被广泛使用。
-不要使用太短的名字，比如一个字母，除非是广泛接受的特例（i/j/k/m/n 表示临时使用的整数，c/d/e 表示临时使用的字符）。
-避免含糊、混淆或者误导。

另外，不要混合使用英文和汉语拼音。由于很多类库使用的是英文，如果使用汉语拼音命名，会造成事实上的拼音名字与英文名字的混用，所以也要尽量避免使用拼音命名。

名字太长怎么办

如果名字没有超过20个字符，长一点也没关系。如果是代码内部使用标识符，要是使用它的代码还能保持在80个字符以内，再长一点也可以。毕竟，容易理解是最重要的。

如果确实有太长的时候，可以使用首字母缩略词，比如把server name indication缩略成sni，使用类似于sniServerName这样的命名。不要太担心缩略语不好理解的问题，我们可以通过注释或者接口规范来解释清楚缩略语代表什么意思，以及缩写的名字具体的含义。比如说， @param sniServerName the server name of a Server Name Indication (SNI)

阿里Java编程规范

《阿里巴巴Java开发手册》是阿里内部Java工程师所遵循的开发规范，涵盖编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程规约、设计规约7大维度。推荐大家使用。

下载地址：http://click.aliyun.com/m/1000019584/

在IDEA中使用代码检查插件

搜索插件并安装，重启idea后生效：