美文网首页
怎样写好的变量名?

怎样写好的变量名?

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

为什么需要命名规范?

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

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

Java命名规范

java命名规范

取好名字的三条原则

1.要有准确的意义

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

  1. 严格遵守命名规范

不同的编程环境,偏爱不同的命名规范,比如 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后生效:


插件生效后在有不规范的代码处会有黄色的警告线提示,并且给出了改正的方案,如下


全局检查不规范的代码:选择一个模块,然后鼠标右键,然后选择编码规约扫描


扫描后,不规范的代码就会进行如下显示:


插件独家视频教程:http://click.aliyun.com/m/1000019586/
IDEA插件与Eclipse插件使用指南:http://click.aliyun.com/m/1000019587/

相关文章

  • 怎样写好的变量名?

    为什么需要命名规范? 二流程序员写代码给机器看,一流程序员写代码给人看。 为标识符提供附加的信息,赋予标识符现实意...

  • 我建议你这样学填词

    经常有朋友问,要怎样写好宋词? 其实这个问题和怎样写好诗,怎样写好散文,怎样写好求职简历是一样的。 你得先弄清楚宋...

  • 怎样写好作文结尾

    我们知道了怎样写好作文开头,怎样写好作文内容,今天分享怎样写好作文结尾。 俗话说,“织衣织裤贵在开头,编筐编篓全在...

  • 怎样“写好”文章

    实验一 心理学家兰德和赛格尔就做过一个实验,让一些男人来看论文,要求在看完论文后给出评价。在文章的最后贴着作者的照...

  • 如何写好文章

    如何写好文章,不是我去教授别人怎样写好文章,而是我发自内心的呐喊,我怎样才能写好文章。 写好文章,一直是我期待和奢...

  • less、sass、stylus的使用

    一、less 1.变量 语法:用@声明变量,@变量名:变量值; 使用: 2.混合 混合实际上就是将写好的css直接...

  • 自媒体运营,如何写好原创文章?什么样的文章才能获得高的阅读量?

    这个问题需要分成两个问题: ——怎样算是写好文章? ——如何写好原创文章? 下面,分别谈小编的分析。 第一,怎样算...

  • 中考作文结尾技巧

    作文是语文的重头戏,写好考场作文是重中之重。此前已经归纳过如何写好作文开头,今天就和同学们说说怎样写好结尾...

  • 怎样写好字

    今天上语文课时,戴老师让我们学写字,写一、二.三、上四个字,我们全班同学好多得了100分,我也得了100分,老师还...

  • 怎样把文章写好,

    写东西的人,往往都纠结过这样的问题:什么样子的文字才是美的?怎么样才能把文字写得很美? 先解决一下,什么样子的文字...

网友评论

      本文标题:怎样写好的变量名?

      本文链接:https://www.haomeiwen.com/subject/anxpkhtx.html