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

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

相关文章推荐

Java代码规范

Java代码规范 本Java代码规范以SUN的标准Java代码规范为基础,为适应我们公司的实际需要,可能会做一些修改。本文档中没有说明的地方,请参看SUN Java标准代码规范。如果两边...

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

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

阿里JAVA编码规范手册

  • 2017-10-12 18:34
  • 589KB
  • 下载

java中文乱码解决之道(七)-----JSP页面编码过程

我们知道JSP页面是需要转换为servlet的,在转换过程中肯定是要进行编码的。在JSP转换为servlet过程中下面一段代码起到至关重要的作用。 在上面代码中有两个地方存在编码:pageEncodi...

Java语言编码规范.PDF

  • 2017-09-25 16:40
  • 217KB
  • 下载

Java语言编码规范.docx

  • 2017-08-17 10:36
  • 62KB
  • 下载

Java中字符编码和字符串所占字节数

Java中字符串所占的字节数和字符编码密切相关。 Java编码实际上可以涉及这几个方面的知识:IDE的编码,操作系统默认编码,Java字符编码。 例如:我们使用eclipse编写Java程序时,可...
  • zklth
  • zklth
  • 2011-11-27 16:34
  • 4385

java编码规范

  • 2016-12-16 12:00
  • 226KB
  • 下载

JAVA编码规范

  • 2015-06-27 10:55
  • 142KB
  • 下载
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

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