代码规范

代码规范

良好的代码习惯可以帮助我们提升代码质量,方便找bug,同时也帮助其他程序员理解我们的代码。不同项目要求的代码规范不同,在lab5中我们使用了Google或Oracle的规范,对代码进行习惯进行修改。

Check Style

我们可以通过CheckStyle工具对我们的代码规范进行检测。
在Eclipse中我们可以在Help->Eclipse Marketplace中下载Checkstyle工具。在项目中右键Checkstyle中Check code with checkstyle即可进行代码风格检测。出现代码风格问题的地方会提出warning并标黄。

修改代码中出现tab字符

修改方式:在Window->Preference->General->Editors->Text Editor中选择Insert Spaces for tabs
代码规范
在Windows->Java->Code Style->Formatter中创建一个新的profile
代码规范
点击Edit,选择Spaces only
代码规范

导入文件辅助修改

通过eclipse-java-google-style.xml文件,按ctrl+shift+f即可快速修改。

其他问题

在每一个public方法前都应该添加注释
包名应该小写,类名应该大写,可用Refactor->Rename进行快速修改。
在if语句,要加上{},哪怕只有一条语句。
等等

代码习惯

代码习惯也很重要,它与远离bug,易读性,可改动性息息相关。

DRY (Don’t Repeat Yourself)

代码应该避免机械性的重复,重复相同的代码会降低代码的可读性,通过封装函数,枚举类型等等方式减少代码机械性的重复。

注释

代码中需要添加注释,特别是public方法,使得别人调用你的方法时,能明白你的条件,目的,作用。注释通常使用Javadoc标准写出,@param解释参数,@return记录返回值等。在ADT中也要进行注释。注释应当在合理的地方注释,没必要全篇注释

Fail-fast

快速报错,可以帮助我们快速的找到bug。静态检测比动态检测更早报错。通过对一些条件的判断,通过return,throw exception, assert等方式进行报错。

变量

变量的命名以及使用也需要规范,如果全篇都是abcd这种字符型变量命名会使程序难以理解。通常Java通过大小写进行命名,不使用_,如variableName类似的命名方式。变量的使用也是,一个变量尽量只用于一种情况。减少使用全局变量的情况,全局变量即static类型,在任意位置进行读取赋值,通常不利于代码的debug,使用风险也较大。

写测试

不是通过控制台输入的方式,而可以通过junit进行各个方法的测试。