建议 1:不要在常量和变量中出现易混淆的字母

在捧读《编写高质量代码改善Java程序的151个建议》的过程中,也一一印证这自己所遇到的问题,有所感、有所悟,所以借简书这样一个平台希望和大家进行分享。

包名全小写,类名首字母全大写,常量全部大写并用下划线分割,变量采用驼峰命名法(Camel Case)命名等,这些都是最基本的Java编码规范,是每个人Javaer都应熟知的规则,但是在变量的声明中要注意不要引入容易混淆的字母。

猜一下,下面的代码打印结果是多少呢?

public class Client {
    public static void main(String[] args) {
        long i = 1l;
        System.out.println("i的两倍是:" + (i+i));
    }
}

实践是检验真理的唯一标准,不妨将代码放到我们的开发工具中执行一下。
参与教学工作以来特别是对于没有基础的同学一个bug可能需要解决很久,到头来往往还只是一些小问题:
1、中英文标点符号使用错误;
2、缺少单词;
3、如上面的问题“I”和“1”放到一块导致的问题;
……
而在我们接下来的开发过程中所遇到的问题不乏会有这些。同样的,在我们工作中也有可能因为如上的问题从而导致程序结果执行错误。所以这就要求我们规范自己的开发规范,养成良好的开发习惯。
1、应该在每个程序的开始都加上注释,解释该程序的目的、作者以及程序最后一次被修改的日期和时间;
2、使用空行和空格来增强程序的可读性(Ctrl+shift+f,有的电脑型号不一样可以自行设置);
3、驼峰式命名;
4、最好进行英文命名便于其他开发人员了解其含义;
……
具体的开发规范还有很多不妨参考一下《阿里巴巴开发手册》,并且一般在我们开发之前也会就本项目进行相关规范并形成相应的文档以便进行查询和对接。
也希望大家在接下来的工作和学习中能够养成良好的开发规范,减少自己的错误,也便于对方的阅读。

你可能感兴趣的:(编写高质量代码的建议)