JAVA编码规范2012.doc

DOWHILE
编码规约
1. Java语言版
2012年4月19日
<
目录>
第1章目的 2
第2章 Java言語一般 3
Source文件 3
文字code 3
一行的文字数 3
文件头注释 3
构成 3
记述顺序 3
外观 5
语句块 5
缩进 5
关于空格 7
数组的声明 7
Javadoc注释 8
注释记述 8
类说明 8
field说明 8
方法说明 9
注释 10
通常注释 10
TODO注释 10
多OS(操作系统)的对应 11
文件路径分隔符 11
其他注意事项 12
对实例变量的无条件参照的禁止 12
禁止在控制语句后出现单行语句 12
Switch文中禁止省略default, break 13
不被推荐的API请不要使用 13
Import文 13
不要使用硬编码 13
命名规则 15
基本规则 15
省略型的命名 15
目的
本文是由度微尔科技整理的专门针对Java语言定义的Coding规约,其中参考了大量各个公司开发项目的Coding规约及Java语言通用的Coding规约。目的是使开发人员在进行集体开发时,使程序有个统一的规范,使程序更容易理解,更容易维护。
声明:针对各个项目的开发需要,度微尔科技保留对该规约的修改权。
Java言語一般
Source文件
Java的Source文件的规约。
文字code
Source文件的文字code是UTF-8(日文开发的情况下选择Shift-JIS )。
★不要使用Unicode , EUC-JP等文字code
一行的文字数
Source文件的一行的长度最大为100个文字(既存Source中如果有超过100个字符,可以无视)。考虑到容易阅读,如果有超过100个文字的情况下、请在任意的位置改行,改行的时候,请注意以下几点。
(1) “运算符的前边”等,最好找适当的位置换行
(2) 换行后的第二行以后的行,要进行两个以上字符位的缩进
文件头注释
文件的头注释,按以下的形式记述。
文件的头的前后不要有空行,在头注释的后边紧接着加package文的记述。
/*
* XXXX系统
* @(#)
* Copyright (c) 2011-2012 DoWhile Corporation
* author : dowhile
* ***@version 2011/03/06
*/
package ;
import .*;
...
构成
Source文件内,关于方法和变量的记述位置的规约
记述顺序
类内的记述位置,按以下的各级别进行判断。
级别1:种类
级别2:访问限定词
级别3:其他限定词
■类内的顺序
级别1:种类
级别2:访问限定词
级别3:其他限定词
①field
①public
①abstract
②构造方法
②没有指定
②static
③方法
③protected
③final
④内部类
④private
★有多个限定词的情况下,按限定词从多到少的顺序记述
public static final field/方法
public static field/方法
public final field/方法
protected field/方法
外观
关于Source文件内的缩进的规约。
语句块
语句块的开始符”{“, 要放在该行的右边、即,”{“的前边不改行。
语句块的结束符”}”,要在其后边改行,但是if-else 和try-catch-finally等的else, catch, finally要放在同一行”}”的后边
例:
○
void main(String[] args) {
……
}
×
void main(String[] args)
{
……
}
例:
○
if (a > b) {
……
} else {
……
}
○
try {
……
} catch (PgApplicationException e2) {
……
} finally {