文档介绍：java编码规范
编码风格
编码风格参考Java Coding Standards。我们采用以上一致的编码风格以规范代码的书写,方便对源代码的理解和交流。
除参考上述文档外,以下各节对需要特别注意的几点进行说明。
命名
用完整的英语精确描述变量/field/class
尽量使用相关领域的术语
使用大小写来分隔不同的单词
尽量不要用单纯的首字母缩写,影响可读性
命名不要过长,不超过15个字母
缩写词应全部大写,比如SQL,WSDL,XML等
缩进与括号
缩进采用Eclipse默认值,Block缩进为4,续行缩进为8。
Block括号的格式采用Eclipse默认的格式。虽然本质上采用哪种格式并没有多少差别,但是我们应尽量和行业规范一致, 采用如下所示的Block括号格式:
Eclipse/JBuilder default style –续左新右(左括号续前行,右括号开新行)
if (condition1) {
statement1;
}
else {
statement2;
}
而不要采用如下格式
//Traditional Visual Studio style –现微软官方C#源代码已放弃这种格式
if (condition1)
{
statement1;
}
else
{
statement2;
}
下面这种过于紧凑的结构也请不要采用
//Some Java style
if (condition1) {
statement1;
} else {
statement2;
}
Format功能。【提示】当你发现已存在的代码不符合编码规范时,可以尝试一下右键或菜单项Source->Format,以及快捷键Ctrl+Shift+F。
代码分段
两个相邻函数定义之间空一行。
不同的意群之间一定要空一行,比如对要定义的变量按意义/作用不同的分组,函数内部的句群分组,一般3/5句就可以成为一个句群。这些都要空一行。
函数中的每一处注释前空一行,比如:
public returnType methodName() {
// comment1
statement1;
// comment2
statement2;
// comment3
statement3;
}
空格
基本上,相邻的词法单位之间都要空一个空格,但以下情况除外:
一元操作符如“++”、“--”、“!”、“-”、“(类型)”等前后不加空格。
“[]”“.”这类操作符前后不加空格,如a[n] + ;
方法名之后不要留空格,紧跟左括号。
“(“,”)”括号的空格可以自己控制,原则上可加可不加,但适当加空格可以帮助理解,比如( ((a + b) * (c – d)) / x )。
注释
注释可以使用中文或英文书写。
注释尽量简洁
注释需注明为什么这样做,而不是简单说做了什么。
三种注释及其作用:
/** ... */ : javadoc可提取的信息
// ... : 普通注释,可以连续多行
/* ... */ : 一般用于注释掉已存在的代码
注:多行注释使用第二种格式,请不要使用第三种格式,以便于在调试时注释掉整段代码。
类、接口必须