Java编码约定

原创 2015年11月21日 16:46:34

优秀的代码胜过冗长的文档

1. 文件编码
源文件编码格式为UTF-8。

2. 包名使用小写字母

3. import不要使用通配符
即,不要出现类似这样的import语句:import java.util.*;

4. 列长限制
一个项目可以选择一行120个字符的列限制,超出列长限制时换行,换行时缩进至少4个空格,缩进不要用tab。

5. 注释
注释应少而精,代码的关键处应该有注释, 注释不能误导读者。

6. 变量声明
每次只声明一个变量,不要使用组合声明,比如int a, b;
需要变量时才声明,并尽快进行初始化。

7. 命名约定
命名应该:见名知意、简洁,避免拼音与英文混用。
命名风格:
类名以UpperCamelCase风格编写
非常量字段名、方法名、参数名、局部变量名以lowerCamelCase风格编写
常量名以CONSTANT_CASE风格编写

8. 类成员顺序
每个类应该以某种逻辑去排序它的成员,维护者应该要能解释这种排序逻辑。比如,新的方法不能总是习惯性地添加到类的结尾。

9. 慎用System.out.println()
使用log而不是System.out.println()

10. 使用大括号(即使是可选的)
大括号与if, else, for, do, while语句一起使用,即使只有一条语句(或是空),也应该把大括号写上。

11. 减少代码嵌套
代码嵌套层次达3层以上时,一般人理解起来都会困难。
减少嵌套的方法有很多:(1)合并条件;(2)利用return以省略后面的else;(3)使用子方法

12. 异常处理
捕获的异常不能忽视,典型的响应方式是打印日志

参考资料:
1. Google Java编程风格指南 http://www.hawstein.com/posts/google-java-style.html
2. Java代码规范 http://blog.csdn.net/huaishu/article/details/26725539

版权声明:本文为博主原创文章,未经博主允许不得转载。

Google Java编程风格指南(献给那些没有良好编码习惯的程序员们)

作者:Hawstein出处:http://hawstein.com/posts/google-java-style.html声明:本文采用以下协议进行授权: 自由转载-非商用-非衍生-保持署名|Cre...

java进阶(一)------java编程规范---命名约定

除了部分传统用法的命名例如 sin,cos等,建议在java语言编写的所有程序中使用这些约定。 包的名称 为了使包的名称广泛可用,它的第一个标识符包含两个或三个小写字母,它们指定了一个Intern...

JAVA编码规范之约定优于配置

文章来自维基百科 约定优于配置(convention over configuration),也称作按约定编程,是一种软件设计范式,旨在减少软件开发人员需做决定的数量,获得简单的好处,而又不失灵活性...

IDEA阿里巴巴Java编码规约扫描插件

  • 2017年11月23日 18:05
  • 7.82MB
  • 下载

阿里巴巴Java编码规范2018

  • 2017年11月02日 15:09
  • 877KB
  • 下载

转一篇关于编码风格习惯的文章---优秀Java程序员的编程风格

今天突发奇想,对编码习惯和编程风格很感兴趣,于是乎,找了一下关于编程风格(Java篇)的资料,希望对爱好编码或者开始学习编码的同学有帮助! 来自《The Elements of Java Sty...
  • cawonlu
  • cawonlu
  • 2014年12月08日 09:06
  • 184

java编码规范

  • 2017年11月02日 09:24
  • 34KB
  • 下载

IO_缓冲流_转换流_字节转为字符_乱码分析_编码与解码JAVA152-154

IO_缓冲流_转换流_字节转为字符_乱码分析_编码与解码JAVA152-154

java文本编码转换

  • 2016年09月03日 17:02
  • 2KB
  • 下载
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Java编码约定
举报原因:
原因补充:

(最多只允许输入30个字)