JAVA编码规范PPT教学课件

Java基础编码规范1. 语法基础标识符、关键字、保留字标识符：由程序员指定的变量、⽅法、类、接⼝等的别名.。

标识符规范：区分⼤⼩写;⾸字母可以是下划线、字母、美元。

但不能是数字;出⾸字符以外的其它字符，可以是下划线、字母、美元和数字;关键字不能作为标识符.关键字：语⾔已经定义好的类似于标识符的保留字符序列，不能挪作他⽤，关键字⼀律⼩写表⽰。

保留字：在语⾔中既不能当作标识符使⽤，也不是关键字，也不能在程序中使⽤的字符序列，Java语⾔的保留字只有const，goto，其中const可以使⽤public static final 来代替。

Java分隔符：分号：表⽰⼀条语句的结束。

⼤括号：表⽰⼀个语句块，即语句的⼀个集合，在定义类和⽅法是，语句块也被⽤作分隔类体或⽅法体。

空格：适当的使⽤空格可以改善代码的可读性。

变量：变量所代表的内容是可以修改的。

常量：变量的内容是不可以的被修改的，常量⼀旦被初始化就不能被修改。

事实上常量：有三种类型：静态常量，成员常量和局部常量。

变量作⽤域:作⽤域规定了变量的适⽤范围，超过了变量作⽤域，变量内容就会被释放，根据变量作⽤域的不同可以分为全局变量和局部变量。

2. 编码规范除了包和常量以外，java编码规范均使⽤驼峰命名法。

包名⼀律全部⽤⼩写，作为命名空间，包名必须具有唯⼀性。

⽅法名、变量名使⽤⼩驼峰命名法，如balanceAccount。

类和接⼝名、⽂件名使⽤⼤驼峰命名法，如CatDao。

常量，全部使⽤⼤写，多个单词构成可以使⽤下划线间隔开。

3. 注释规范⽂件注释：即在每⼀个⽂件的开头进⾏注释，⽂件注释通常包括版权信息、⽂件信息、历史版本信息和⽂件内容等等。

⽂档注释：⽂档注释就是可以⽣成API帮助⽂档的注释，⽂档注释主要针对类（或者接⼝）、实例变量、静态变量、实例⽅法、静态⽅法等进⾏注释，主要提供给不看源码的⼈做参考⽤代码注释：给阅读源码的⼈以参考的代码注释地标注释：在源代码中添加⼀些表⽰，以便于IDE⼯具快速定位代码。

文档修订记录1引言 (5)1.1文档目的 (5)1.2本规范的指导意义 (5)1.3文档预期读者 (5)1.4文档适用范围 (5)1.5参考文档 (6)2JA V A代码开发规范 (7)2.1命名规范 (7)2.1.1 文件File (7)2.1.2 包Package (7)2.1.3 接口Interface (7)2.1.4 类Class (8)2.1.5 方法Method (8)2.1.6 参数Parameter (9)2.1.7 变量Variable (9)2.1.8 实例变量Instance Variable (10)2.1.9 常量Constant (10)2.1.10 数组Array (10)2.2格式规范 (11)2.2.1 版权信息Copyright Information (11)2.2.2 注释Comment (11)2.2.3 缩进Indentation (13)2.2.4 空格Space (13)2.2.5 空行Blank Line (13)2.2.6 行长度Line Length (14)2.2.7 换行New Line (14)2.2.8 圆括号Parentheses (15)2.2.9 大括号Big Brackets (15)2.3语句规范 (16)2.3.1 变量、常量的使用 (16)2.3.2 简单语句Simple Statement (16)2.3.3 条件语句Condition Statement (17)2.3.4 分支语句Switch Statement (17)2.3.5 循环语句Loop Statement (18)2.3.6 包和引入语句Packet and Import Statement (19)2.3.7 声明语句Declare Statement (19)2.3.8 例外控制语句Exception Control Statement (20)2.3.9 类和接口Class and Interface (20)2.3.10 构造/析构Constructor/Finalizer (21)2.3.11 方法Method (21)2.3.12 属性Attribute (23)2.3.13 SQL语句SQL Statement (24)2.4日志规范 (25)2.5一般性规范 (26)2.6其它代码开发规范 (27)2.6.1 多线程Multi-Threading (27)2.6.2 Servlet (27)2.6.3 JDBC (28)2.6.4 异常规范 (29)2.6.5 工程配置文件规范 (30)1引言1.1文档目的制定这个规范的目的是为了增加代码的可读性，使项目的所有代码具有统一的编码风格，减少人员变动造成的损失，提高软件开发团队的生产效率，有利于相关项目（票据集中提入、批量代收付、影像采集、前后台分离）向营运平台整合。

JAVA编码规范目录JAVA编码规范 (1)1 概述 (7)1.1范围 (7)1.2说明 (7)2 文件体系结构 (8)2.1文件体系规则 (8)规则2.1.1 JSP文件目录结构 (8)建议2.1.2 Java文件目录结构 (8)2.2源文件结构规则 (9)规则2.2.3 类变量的声明顺序是public,protected,package,private (9)规则2.2.4 变量、常量的注释应放在其上方相邻位置 (9)规则2.2.5 用递增的方式写构造器（比如：参数多的写在后面） (9)规则2.2.6 类变量的存取方法：get和set方法 (9)规则2.2.7 如果定义main() 方法，必须将main方法写在类的底部 (9)3 文件命名规则 (10)规则3.1S TRUCTS配置文件命名 ............................................. 错误!未定义书签。

规则3.2JSP文件命名 (10)规则3.3J AVA文件命名 (10)4 排版规则 (11)4.1语句排版规则 (11)规则4.2.1简单语句每行至多包含一条语句 (11)规则4.2.2 复合语句被括其中的语句缩进一个层次 (11)规则4.2.3 左大括号"{"应位于复合语句起始行的行尾，前面需加一个空格符；右大括号"}"应另起一行并与复合语句首行对齐。

(11)规则4.2.4 必须用"{"和"}"将if内的语句括起来。

(即使只有一条语句的情况下) (11)规则4.2.7 在多层嵌套的for语句中，应在for上一行增加逻辑注释 (12)建议4.2.14 “=”等比较符前后加一个空格 (12)5 注释规则 (13)5.1类注释规则 (13)规则5.1.1 使用JavaDoc，列出功能、版本信息、日期、作者和版权声明 (13)规则5.1.2 如果对文件进行了修改，必须说明修改目的、修改日期、修改人，并变更版本信息 (13)5.2类方法注释规则................................................................. 错误!未定义书签。

编码规范1.编写目的本规范的目的在于编写可靠的、一致的、便于理解的JAVA源代码，并且写出的代码被其他人阅读，所有的JAVA代码保持良好的致性，容易在以后的阶段中进行维护和升级。

同时，也是为了通过一定时间的实践，增加我们的软件产品的投入产出量，以提高我们的工作效率。

2.适应范围适用于JAVA程序开发人员，或后续开发人员。

可以方便系统的开发与维护，使系统开发与维护可以顺利展开。

3.代码命名一般原则我们开发的是一个JSP新闻发布系统，用的编码方式是JAVA，因此用的命名总原则是：3.1.用全英文单词命名的方式，准确地描述变量、属性、类等。

如：使用firstNname、grandTotal、等命名就比x1、y1、fn等更容易让人理解其含义，尽管它们的长度要大一些。

3.2．采用一些更加准确的术语来命名。

例如：如果我们的用户称他们的clients为customers ，那么我们就应该用customer来命名，而不是采用client来命名。

这是一些细微的地方，但也希望能注意。

3.3．采用大小写混合的方式来命名，以便命名有很好的可读性。

在JAVA代码中，将采用如下原则：类或接口命名中每个单词的首字母均大写，而单词的剩余部分均小写。

其它像变量、成员方法、属性等除第一个单词全部小写以外，其它单词的首写字母均大写，而单词的剩余部分均小写。

3.4．尽量少用单词的缩写形式，但如果一定要用，则选择大家通用的缩写方式，并且要在本JAVA源代码中坚持用它，而不要一会用这种缩写方式，一会用那种缩写方式。

比如，如果要用“number”的缩写方式，则可用“no”或“num”两种缩写方式，而不要用“nu”这种大家不常用的缩写方式，并且要保持不变。

3.5．尽量避免太长的命名，一般以少于20个字符为宜。

3.6．尽量避免使用这样命名：两个或多个命名仅仅是其中的有些字符大小写不一样，或者仅仅是其中有些单词是单复数之区别。

例如：persistentObject与persistentObjexts；anSqlDatabase与anSQLDataBase等。