自己简单总结下代码规范吧,可能并不是很完整。想到哪儿就写到哪儿吧。
1、驼峰命名法,其实这个也没什么可说的了。
类名/接口名 :一般是首字母大写,后面跟着的单词首字母大写。比如:User、UserList;
方法名:首字母小写,后面跟着的首字母大写。比如:getUserList()、getPulicAccountInfo();普通的变量名也是如此。
常量:一般全大写,单词与单词之间用下划线隔开。比如:SR_EXCEPTION,SR_SUCCESS;2、
if() {
// TODO
} else {
//TODO
}
比如上面的代码:小括号与中括号之间留一个空格的位置,同时没有写代码的地方要用 // TODO 作为标识,提示自己此处需要写自己的代码,相当于一个备忘录的效果,下次在看自己代码的时候,知道这里还有工作没做。
3、类名上面必要的注释信息。
比如author、date、email以及说明信息(这个类是干什么的)
/**
*<p>消息管理</p>
* @author luxuebing
* @date 2017/10/20
*/
方法上面的注释:
比如:
/**
* <p>编辑群发消息</p>
* @param request
* @param mm
* @param dto
* @return
*/
代码中的单行或者多行注释:
// 这是单行注释
/*这是多行注释*/
4、在使用equals方法进行比较时,尽量用非空的字符串去调用。比如"".equals(user),而不是用user.equals(""),避免抛出NPE;
5、MyBatis的Mapper文件中sql语句尽量全部大写。
6、包名一般小写。比如com.fairy.entity;
7、见名思义,让人一看就知道这个东西是干什么用的。
比如xxxService、xxxDao、xxxImpl、xxxAction、xxxFactory、xxxBean。
8、在命名时尽量不要使用拼音。推荐使用英文,不知道的可以去搜一下对应的英文单词。
9、方法名一般动词在前。动词作为前缀往往表达特定的含义。
比如:createOrder、insertUser、deleteOrder、initPool(初始化获取某某资源)、close(open)Connection(打开关闭连接)、get(set)Username(设置、取得用户名)、findMessageList、updatePassword等等。
10、使用utf-8编码。
11、尽量不要让代码报黄色警告。不用的类或者包该去掉就去掉,Eclipse下可以使用快捷键(Ctrl+Shift+O)快速修正导入(它会自动导入你需要的包、类,去掉不需要的)
12、运算符之间使用一个空格隔开。
比如a + b = c;
return a == b ? 0 : 1;
13、该换行的地方要进行换行,为了阅读上的方便。空行的使用也要注意,比如方法与方法之间,或者是一段代码逻辑与另一段之间的分割。
14、不要对布尔值进行true或false的判断,这样看起来会很蠢。
15、不要做过多的嵌套循环,这样会让你的代码在阅读上有障碍。
16、涉及到大量字符串的拼接,用StringBuilder。
17、异常捕获到必须处理。
18、代码中尽量不要使用System.out.println()语句,根据优先级不同用log.debug()/log.info()/log.error();
19、要养成写单元测试的习惯。
20、尽量使用null == obj/null != obj;常量在前、变量在后。这种写法虽然从意义上来说,和obj == null没有区别,但是是一种规范。为了避免在写代码时少写了一个=号,防止错误的。
今天就先写到这里吧,以后会慢慢完善它的。在实际开发中注意总结归纳。具体的可以参见《阿里巴巴Java开发手册》
说下我平时比较常用的一些快捷键吧(Eclipse)
1、Alt+/ 自动提示
2、Ctrl+2 L 会生成一个变量去接受返回值。比如写个new HashMap
Alt+/提示出来后,用Ctrl+2 L后会生成 HashMap<Object, Object> hashMap = new HashMap<>();
3、Ctrl+L 输入行数可以快速到某一行。
4、Ctrl+Q 快速回到上次你编辑的地方。
5、Alt+Shift+S format 格式化代码
6、Alt+Shift+Z Try/Catch 将你的代码放在try catch块中。
7、Ctrl+M 最大最小化当前编辑的窗口。
8、Ctrl+T 查看当前类的继承关系。
9、Ctrl+O 查看当前类的结构(变量名、方法名一目了然)。
10、Alt+Shift+S R 生成getter/setter方法
11、Alt+Shift+S O 生成有参构造方法
12、Alt+Shift+S C 生成无参构造方法
13、Alt+Shift+S S 生成toString方法
14、Ctrl+1 快速修复。比如现在有一个类实现了某个接口,它会提示报错,让你去实现接口中的方法。将鼠标放在类上或者使用Ctrl+1都可以快速实现该接口中的所有方法。看个人习惯吧,我比较习惯使用键盘修复。
15、Ctrl+F 在当前文件下去查找某个变量。
16、Ctrl+Shift+T 打开类型。在整个工程下去查找某个类或者方法。
17、Alt+向上/下箭头 将当前行上下移动。
18、Ctrl+Alt+向上/下箭头 向上向下复制当前行。(以上两个快捷键都是免去Ctrl+C Ctrl+V的麻烦)
19、Ctrl+Shift+O 快速修正导入。这个上面已经说过了。
20、Ctrl+D 快速删除当前行
21、Ctrl+S 保存。这个其实感觉没必要说了,最常用的一个快捷键了。
22、Shift+Tab 取消缩进。即向前移动代码。
23、Shift+Enter 当前行向下换行。(这个其实觉得很实用。比如一行代码写的很长,普通的换行需要将光标移动至行尾,再按下Enter键换行,比较麻烦)
24、Ctrl+Shift+Enter 当前行向上换行。
25、Alt+Shift+S 运行main方法(或者鼠标右键,run as javaApplication,根据个人习惯)
26、ctrl + shift + Y 全变小写
27、ctrl + shift + X 全变大写
28、ctrl + shift + G 定位到所有引用此方法的位置
29、ctrl + Q 定位到上次修改的位置
30、ctrl + K 将鼠标放在变量上,可以查找此变量出现的下一个位置
31、ctrl + E 显示当前窗口的所有editor列表
32、Alt + shift + M 将选中的代码抽取成方法,在重构时使用。
33、Alt + shift + C 修改方法的结构
34、ctrl + W 关闭当前的Editer
大概就是这些了。最后说一句,不要过度依赖快捷键,它只是IDE辅助开发的工具而已,能在一定程度上提高开发效率。但是很多时候还是要自己一个一个打出来,不能忘了手写代码才是基本功。