没有合适的资源?快使用搜索试试~ 我知道了~
项目管理中的Java编码规范,用于团队编码风格统一,代码避免产生低级错误等
资源详情
资源评论
资源推荐
Java 编码规范
Java 编码规范
目 录
1. 文件名.............................................................................................................................................3
1.1 文件后缀...................................................................................................................................3
1.2 常用文件名...............................................................................................................................3
2. 文件组织.........................................................................................................................................3
2.1 Java 源文件...............................................................................................................................4
2.1.1 包和引入语句........................................................................................................ 4
2.1.2 类和接口声明........................................................................................................ 4
3. 缩进排版.........................................................................................................................................5
3.1 行长度.......................................................................................................................................5
3.2 换行...........................................................................................................................................5
3.3 对于{}.......................................................................................................................................7
4. 注释.................................................................................................................................................7
4.1 实现注释的格式.......................................................................................................................7
4.1.1 块注释................................................................................................................... 8
4.1.2 单行注释............................................................................................................... 8
4.1.3 尾端注释............................................................................................................... 8
4.1.4 行末注释............................................................................................................... 9
4.2 文档注释...................................................................................................................................9
4.3 注释内容.................................................................................................................................10
4.3.1 方法注释.............................................................................................................. 10
4.3.2 算法注释.............................................................................................................. 10
4.3.3 可精简的注释内容.............................................................................................. 11
4.3.4 推荐的注释内容.................................................................................................. 11
4.3.5 Null 的规约.......................................................................................................... 11
4.3.6 特殊代码注释...................................................................................................... 11
5. 声明...............................................................................................................................................12
5.1 每行声明变量的数量.............................................................................................................12
5.2 初始化.....................................................................................................................................12
5.3 布局.........................................................................................................................................12
5.4 类和接口的声明.....................................................................................................................13
5.5 声明规则.................................................................................................................................13
6. 语句...............................................................................................................................................14
6.1 简单语句.................................................................................................................................14
6.2 复合语句.................................................................................................................................14
6.3 返回语句.................................................................................................................................14
6.4 if,if-else,if else-if else 语句...............................................................................................15
6.5 for 语句....................................................................................................................................15
第 1 页 共 26 页
Java 编码规范
6.6 while 语句...............................................................................................................................16
6.7 do-while 语句..........................................................................................................................16
6.8 switch 语句..............................................................................................................................16
6.9 try-catch 语句..........................................................................................................................17
7. 空白...............................................................................................................................................17
7.1 空行.........................................................................................................................................17
7.2 空格.........................................................................................................................................17
8. 命名规范.......................................................................................................................................18
8.1 命名规则.................................................................................................................................19
8.1.1 包命名................................................................................................................. 19
8.1.2 类、接口命名...................................................................................................... 20
8.1.3 方法命名.............................................................................................................. 20
8.1.4 变量命名.............................................................................................................. 20
81.5 常量命名............................................................................................................... 20
9. 编程惯例.......................................................................................................................................21
9.1 提供对实例以及类变量的访问控制.....................................................................................21
9.2 引用类变量和类方法.............................................................................................................21
9.3 常量.........................................................................................................................................21
9.4 变量赋值.................................................................................................................................21
9.5 异常处理.................................................................................................................................22
9.6 其它惯例.................................................................................................................................22
9.6.1 圆括号................................................................................................................. 22
9.6.2 返回值................................................................................................................. 22
9.6.3 条件运算符“?”前的表达式*...............................................................................23
10. 信息输出.....................................................................................................................................23
11. 代码范例.....................................................................................................................................23
12.1 Java 源文件范例...................................................................................................................23
第 2 页 共 26 页
Java 编码规范
1. 文件名
这部分列出了常用的文件名及其后缀。
1.1 文件后缀
Java 程序使用下列文件后缀:
文件类别 文件后缀
Java 源文件
.java
Java 字节码文件
.class
JSP 文件
.jsp
XML 文件
.xml
资源文件
.proper#es
日志文件
.log
Tag lib 文件
.tld
Java 包文件
.jar
层叠样式表文件
.css
1.2 常用文件名
常用的文件名包括:
文件名 用途
Build.xml
Ant 编译配置
Web.xml
Java Web 程序的配置文件
Server.xml
Tomcat 的配置文件
log4j.proper#es
Log4j 配置文件
hibernate.cfg.xml
Hibernate 配置文件
Applica#onResources.proper#es
程序的英文资源文件
Applica#onResources_zh_CN.proper#es
程序的 gbk 资源文件
applica#onContext-***.xml
Spring 配置文件
2. 文件组织
一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过
第 3 页 共 26 页
剩余25页未读,继续阅读
huxuqq
- 粉丝: 0
- 资源: 2
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0