【一帘幽梦】让代码变得更加好看

作为一个程序员，要对自己的代码有一定的要求。首先代码要有层次要整齐，然后就是注释要描述详细，注释的格式也要一致，还有就是变量方法类名命名要有意义。详细规范可以参考阿里巴巴java开发手册。

1、注释规范

（1）一般情况下，源程序的有效注释量必须在30%以上
（2）对类、方法等的注释需要符合JavaDoc规范
（3）注释不能嵌套
（4）代码质量不高但能正常运行，或者还没有实现的代码用//TODO:声明
（5）存在错误隐患的代码用//FIXME:声明
…

JavaDoc注释语法

/**
 * @description:功能描述
 * @params:对方法中参数的说明
 * @return:对方法返回值的说明
 * @version:标明该类模块的版本
 * @author:标明开发该类模块的作者
 * @date: 时间
 */

在idea中可以设置注释模板

2、命名规范

（1）名字应该能够标识事物的特性，并且与业务挂钩，就是要有意义
（2）命名采用驼峰命名，一般类采用大驼峰命名（每个单词首字母都大写），方法和变量采用小驼峰命名（第一个单词首字母小写，之后的每个单词首字母大写）
（3）名字一律使用英文单词，而不能为拼音
…

3、采用工具检测代码

在idea中可以安装阿里巴巴代码检查工具

安装后就可以进行检查了，选择要检查的文件，进行编码规约扫描就可以了

扫描后在控制台有提示，按照提示问题改就可以了