JAVA代码规范

文档信息

目 录

第1章 文件名 ................................................................................................................................. 4 1.1 文件名.................................................................................................................................... 4 1.2 文件后缀 ................................................................................................................................ 4 第2章 文件组织 ............................................................................................................................. 5 2.1 Java源文件 ............................................................................................................................ 5

2.1.1 开始的注释 ............................................................................................................. 5 2.1.2 Package和Import语句 ........................................................................................... 6 2.1.3 类和接口声明 ......................................................................................................... 6

第3章 缩排 ..................................................................................................................................... 8 3.1 行的长度 ................................................................................................................................ 8 3.2 折叠的行 ................................................................................................................................ 8 第4章 注释 ................................................................................................................................... 11 4.1 实现注释的格式 .................................................................................................................. 11

4.1.1 块注释 ................................................................................................................... 11 4.1.2 单行注释 ............................................................................................................... 12 4.1.3 跟踪注释 ............................................................................................................... 12 4.1.4 行末的注释 ........................................................................................................... 12 4.2 文档注释 .............................................................................................................................. 13 第5章 声明 ................................................................................................................................... 15 5.1 每行一个 .............................................................................................................................. 15 5.2 初始化.................................................................................................................................. 15 5.3 位置...................................................................................................................................... 15 5.4 类和接口的声明 .................................................................................................................. 16 第6章 语句 ................................................................................................................................... 18 6.1 简单语句 .............................................................................................................................. 18 6.2 复合语句 .............................................................................................................................. 18 6.3 返回语句 .............................................................................................................................. 18 6.4 if，if-else，if else-if else语句 ............................................................................................. 18 6.5 for语句 ................................................................................................................................. 19 6.6 while语句 ............................................................................................................................. 20 6.7 do-while语句 ....................................................................................................................... 20 6.8 switch语句 ........................................................................................................................... 20 6.9 try-catch语句 ....................................................................................................................... 21 第7章 空白 ................................................................................................................................... 22 7.1 空行...................................................................................................................................... 22 7.2 空格...................................................................................................................................... 22 第8章 命名惯例 ........................................................................................................................... 24 8.1 包 ......................................................................................................................................... 24 8.2 类 ......................................................................................................................................... 24 8.3 接口...................................................................................................................................... 24 8.4 方法...................................................................................................................................... 24 8.5 变量...................................................................................................................................... 25

第I页 文档信息

8.6 常量...................................................................................................................................... 25 第9章 编程习惯 ........................................................................................................................... 26 9.1 对实例和类变量的访问 ...................................................................................................... 26 9.2 对类变量和方法的引用 ...................................................................................................... 26 9.3 常数...................................................................................................................................... 26 9.4 变量赋值 .............................................................................................................................. 26 9.5 其他惯例 .............................................................................................................................. 27

9.5.1 圆括号 ................................................................................................................... 27 9.5.2 返回值 ................................................................................................................... 27

第10章 附录：代码示例 ............................................................................................................. 29 第11章 展示层 ............................................................................................. 错误！未定义书签。 第12章 控制层 ............................................................................................. 错误！未定义书签。 第13章 服务层 ............................................................................................. 错误！未定义书签。 第14章 数据访问层 ..................................................................................... 错误！未定义书签。 第15章 目录结构 ......................................................................................... 错误！未定义书签。

第II页 文档信息

第一篇 开发规范

第III页 第一篇 开发规范 错误！文档中没有指定样式的文字。

Chapter 第1章 . 文件名

第1章 文件名

本节列出了文件名和后缀的命名惯例。

1.1 文件名

【规则1-1】 将文件中的主类名或者主接口名作为文件名，首字母大写。

1.2 文件后缀

【规则1-2】 Java文件使用下列文件后缀，源文件使用.java；编译文件使用.class

【示例】 Customer.java (推荐) account.ja（不推荐）

第4/30页