Java编码规范V1.0.doc

Java 编码规范
文件更改摘要:
日期
版本号
修订说明
修订人
审核人
批准人
目录
1. 介绍 4
为什么要有编码规范 4
注意事项 4
2. 文件名 4
文件后缀 4
常用文件名 4
3. 文件组织 5
Java源文件 5
包和引入语句 5
类和接口声明 5
4. 缩进排版 6
行长度 6
换行 6
对于{} 8
5. 注释 8
实现注释的格式 8
块注释 8
单行注释 9
尾端注释 9
行末注释 9
文档注释 10
注释内容 10
方法注释 10
算法注释 11
11
11
Null的规约 11
特殊代码注释 12
6. 声明 12
每行声明变量的数量 12
初始化 12
布局 12
类和接口的声明 13
声明规则 14
7. 语句 14
简单语句 14
复合语句 14
返回语句 14
if,if-else,if else-if else语句 15
for语句 15
while语句 16
do-while语句 16
switch语句 16
try-catch语句 16
8. 空白 17
空行 17
空格 17
9. 命名规范 18
命名规则 19
包命名 19
类、接口命名 19
19
20
20
10. 编程惯例 20
提供对实例以及类变量的访问控制 20
引用类变量和类方法 20
常量 20
变量赋值 21
异常处理 21
其它惯例 21
圆括号 21
返回值 21
条件运算符“?”前的表达式* 22
11. 信息输出 22
12. 代码范例 22
Java源文件范例 22
1. 介绍
为什么要有编码规范
编码规范对于程序员而言尤为重要,有以下几个原因:
一个软件的生命周期中,80%的花费在于维护;
几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护;
编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码;
如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你已构建的其它任何产品。
制定本规范的目的是为了让代码清晰整洁、增强可读性。所有编码必须围绕此原则,即使是本规范中未特别指明
注意事项
本文档未特别标注的都必须遵守(不遵守将代表代码不合格,会给团队其他成员带来不便和困扰,大大提高总体维护成本)
2. 文件名
这部分列出了常用的文件名及其后缀。
文件后缀
Java程序使用下列文件后缀:
文件类别
文件后缀
Java源文件
.java
Java字节码文件
.class
JSP文件
.jsp
XML文件
.xml
资源文件
.properties
日志文件
.log
Tag lib文件
.tld
Java 包文件
.jar
层叠样式表文件
.css
常用文件名
常用的文件名包括:
文件名
用途

Ant 编译配置

Java Web程序的配置文件

Tomcat的配置文件

Log4j配置文件

Hibernate配置文件

程序的英文资源文件
.properties
程序的gbk资源文件
struts-config-**.xml
Struts配置文件
applicationContext-***.xml
Spring配置文件
3. 文件组织
一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读,应该尽量避免。“Java源文件范例”提供了一个布局合理的Java程序范例。
Java源文件
每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类