Java编码规范技术2016.doc

Java代码规范 修订记录： 日期 作者 修订内容 200 刘科政 初稿 目录 TOC \o 1-3 \h \z \u 1. 前言 5 1.1. 为什么使用代码规范 5 2. 文件名称 5 2.1. 文件后缀 5 3. 文件组织 5 5.1. Java源文件 6 6. 缩进 6 6.1. 行的长度 6 6.2. 换行 6 7. 注释 7 7.1. 代码注释格式 8 7.1.1. 段注释 8 7.1.2. 单行注释 9 7.1.3. 行后注释 9 7.1.4. 行结束注释 9 7.2. 文档注释 10 8. 声明 10 8.1. 每行声明数量 10 8.2. 初始化 11 8.3. 声明位置 11 8.4. 类和接口的声明 12 9. 语句 12 9.1. 简单语句 12 9.2. 复合语句 12 9.3. 返回语句 13 9.4. if, if-else, if else-if else语句 13 9.5. for语句 14 9.6. while语句 14 9.7. do-while语句 14 9.8. switch语句 15 9.9. try-catch语句 15 10. 空格 16 10.1. 空行 16 10.2. 空格 16 11. 命名规范 17 类型 18 命名规则 18 例子 18 12. 编程规则 19 12.1. 实例和类变量的访问 19 12.2. 类变量和类方法的访问 19 12.3. 常量 19 12.4. 变量赋值 19 12.5. 其他规则 20 12.5.1. 括号 20 12.5.2. 返回值 20 12.5.3. 条件操作符中“？”前的表达式 21 12.5.4. 特殊的注释 21 13. 代码实例 21 13.1. Java源文件实例 21 前言 为什么使用代码规范 代码规范对于一个程序员来说是很重要的，原因如下： 软件生命周期中80%的成本是用于维护的。 很少有软件在它的生命周期中是由原作者维护的。 代码规范可以增加软件的可读性，从而使得工程人员可以更快，更透彻的了解新的代码。 如果你以源代码为最终产品，你应该保证源代码应该像其他一切产品一样整洁，规范。 文件名称 这一节列举了常用的文件名及其后缀。 文件后缀 文件类型 后缀 Java源文件 .java Java bytecode文件 .class 文件组织 一个文件是由空行以及可能的注释分隔开的几部分组成的。 应用程序尽量避免超过2000行，如有特殊情形可以考虑超过此限制。 一个格式化很好的Java源文件的例子见第11节。 文件必须有头注释，格式如下：（此处有待商榷）。/** * pTitle:客户端控制类/p * pDescription:商业保险系统 /p * pCopyright: Copyright (c) 2003辽宁奉和信息科技有限公司/p * pCompany: 辽宁奉和信息科技有限公司/p * @author 刘科政（使用中文） * @version 1.0 */ 类或接口的格式及顺序如下： 1 包（Package）定义 2 Import 3 文件的头注释 4 类或接口的声明 5 静态变量的声明 public,protected,package level,private 6 实例变量的声明 public,protected,package level,private 7 构造函数 8 方法 方法应该依据功能进行分块，以使方法宜于阅读理解。{建议将Setter和Getter方法放在最后}。 Java源文件 每一个Java源文件都有一个公共的类或者接口。如果有私有的类和接口和这个公共类有关的话，你可以把他们放在公共类的源文件中。公共类应该是这个文件中的第一个类或者接口。 缩进 缩进以四个空格为一个单位。不能使用Tab键进行缩进。 行的长度 每行的长度不要超过100字符。 换行 当一段表达式不能够在一行完成的时候，按照以下的规则分行： 在逗号之后分行 在操作符之前分行 高层的分行比底层分行好 新行的开始应该和原来行的表达式开始对齐 如果以上代码会引起误解，缩排4个空格 比如： someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpressi