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编码约定

虽然我们可以使用自己的语言进行类变量之间的命名,但是不管什么人类任何语言 没有约定不能规矩。 class---------类名应该是名词 并且首字母需要大写 大小写混用 example:c...
  • wq7570875
  • wq7570875
  • 2012年06月26日 15:26
  • 351

约定优于配置

约定优于配置(convention over configuration),也称作按约定编程,是一种软件设计范式,旨在减少软件开发人员需做决定的数量,获得简单的好处,而又不失灵活性。本质是说,开发人员...
  • zhangzeyuaaa
  • zhangzeyuaaa
  • 2015年02月06日 17:48
  • 8319

Struts2约定优于配置

1.1   需要的jar包struts2-convention-plugin-2.2.1.jar 1.2   设置Convention结果[result页面存放路径目录] struts-plugi...
  • sunchen2012
  • sunchen2012
  • 2016年07月25日 13:45
  • 824

maven系列:实践中理解“约定优于配置”

在学习maven时常会注意到一句“约定优于配置”,此处的“优”应当是优先的意思。这句话的意思能理解,但背景或原因之类的却不是很理解,直到最近。 最近有一个在做一个基于react js的web...
  • laxsong
  • laxsong
  • 2016年03月25日 22:00
  • 1214

Maven之(八)约定优于配置

maven的配置文件看似很复杂,其实只需要根据项目的实际背景,设置个别的几个配置项而已。maven有自己的一套默认配置,使用者除非必要,并不需要去修改那些约定内容。这就是所谓的“约定优于配置”。 文件...
  • u012152619
  • u012152619
  • 2016年05月27日 09:38
  • 3433

对约定优于配置的一点思考

开始思考这个问题,源于近期项目庞大,使用ant脚本已经越来越感到乏力,所以开始尝试使用Maven构建项目,惊讶于只需要简单的几行xml就可以完成原来ant需要大量xml才能完成的工作。不得不说,人们在...
  • shan9liang
  • shan9liang
  • 2013年12月07日 15:27
  • 6137

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

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

Struts2约定

 Struts2引入Convention(约定)插件支持零配置。约定优于配置。 一、约定Action 1.安装Convention插件 将Struts2项目下的struts...
  • kakarot5
  • kakarot5
  • 2015年03月27日 10:45
  • 767

Maven笔记-maven约定的目录

Maven笔记-maven约定的目录
  • hephec
  • hephec
  • 2016年12月01日 09:56
  • 177

maven-约定优于配置

maven是一个高度自动化的构建工具,在很多的项目开发过程中都用到maven,maven主要负责管理项目依赖关系以及jar包。运用了“约定优于配置”的思想,从而提高开发效率和管理秩序。下面谈一下mav...
  • wangdan199112
  • wangdan199112
  • 2015年12月31日 15:34
  • 1204
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Java编码约定
举报原因:
原因补充:

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