文档介绍：Java语言编码规范
(Java Code Conventions)
目录
一、规范简介 1
1 目的 1
2 范围 1
3 参考文档 1
4 说明 1
二、通用命名规则 1
包(package) 1
类(class) 1
接口(interface) 2
方法(method) 2
变量(variable) 2
常量(constant) 2
三、 CHECKITEM、CHECKLINE的标记 2
四、 JAVA编码规范 3
1 文件 3
文件布局格式设置 3
类的设计 4
包和引用(package & import) 4
ment) 4
2 声明(Declarations) 5
每行声明变量的数量(Number Per Line) 5
初始化(Initialization) 5
布局(Placement) 6
类和接口的声明(Class and Interface Declarations) 6
3 语法规则 7
1. 关于循环语句 7
2. 关于条件语句 8
3. 关于变量 9
4. 关于类型转换 9
5. 关于try /catch 9
6. 关于return 9
7. 杂项 10
8. 空白(White Space) 10
空行(Blank Lines) 10
空格(Blank Spaces) 10
4 编程惯例(Programming Practices) 11
提供对实例以及类变量的访问控制(Providing Access to Instance and Class Variables) 11
引用类变量和类方法(Referring to Class Variables and Methods) 11
常量(Constants) 11
变量赋值(Variable Assignments) 11
其它惯例(Miscellaneous Practices) 12
5 性能考虑 13
使用 StringBuffer 对象 13
可移植性 13
换行 14
PrintStream 14
6 JBuilder的编码风格 14
7 《Thinking in Java》中关于Java程序设计的建议 14
规范简介
目的
制订本规范的目的是为培养规范设计和编程,养成良好的习惯,增强JAVA类软件产品的稳定、健壮、可靠性;同时也为提高软件的可读性,可以让程序员尽快而彻底地理解新的代码,使产品可维护性提高而制定的强制性规范,同时也是代码复审的依据。
范围
本规范适用于公司JAVA类代码(包括JSP)的代码编写标准。适用于代码编写阶段和代码维护阶段。
参考文档
《SUN JAVA代码编写规范》。
《Java编程思想》
说明
本文档包括java编码规范。
通用命名规则
包(package)
包名在整个系统必须唯一,必须全部小写,短小而且具有一定的实际意义,如可以按照不同的应用目的或模块进行划分。
包名以”.”分隔,范围从大到小。在本公司,.isoftstone”开头。
类(class)
类名命名一般来说是名词结构的,首字母应大写。类名应具有明确的含义,能在一定程度上表达类的功能。在有多个单词组成的类名中,每个单词的第一个字母必须大写,如果类名过长,可以采用缩写的方式。缩写的单词须具有清晰的含义。
接口(interface)
接口的命名规则同类的命名规则相同,但应以”If”开头来代表接口。
方法(method)
方法的命名一般来说是动词结构的(通常对第一个单词要求是动词),且要求第一个单词的首字母是小写的,要求有清晰的方法含义。在有多单词组合中,要求第一个单词的首字母小写且具有动词意义,其余单词组合的首字母应该大写。在方法名过长的情况下,可考虑缩写,但必须意义明确。
变量(variable)
变量的命名要求尽量具有明确的含义,首字母应小写,避免以”_”或”$”作为开头。
常量(constant)
常量命名要求具有明确的含义,所有字母应全部大写。多个单词组合时,以”_”下划线连接。
当多个常量表示一个类型的不同特征或状态值时,应将共同的部分作为名称的前段,从而在使用IDE工具自动列出成员时能同时见到这些常量。如,表示缓存长度的最大和最小值的两个常量,建议分别命名为BUF_LEN_MAX和BUF_LEN_MIN,而不是MAX_BUF_LEN和MIN_BUF_LEN。
CheckItem、CheckLin