Java语言编码规范.docVIP

密级：内部公开 文档编号： 版本号：V1.0 分册名称：第1册/共1册 Java 编码规范 编制： 生效日期： 审核： 批准： 文件更改摘要： 日期 版本号 修订说明 修订人 审核人 批准人 目 录 1. 介绍 4 1.1 为什么要有编码规范 4 1.2 注意事项 4 2. 文件名 4 2.1 文件后缀 4 2.2 常用文件名 4 3. 文件组织 5 3.1 Java源文件 5 3.1.1 包和引入语句 5 3.1.2 类和接口声明 5 4. 缩进排版 6 4.1 行长度 6 4.2 换行 6 4.3 对于{} 8 5. 注释 8 5.1 实现注释的格式 8 5.1.1 块注释 8 5.1.2 单行注释 9 5.1.3 尾端注释 9 5.1.4 行末注释 9 5.2 文档注释 10 5.3 注释内容 10 5.3.1 方法注释 10 5.3.2 算法注释 11 5.3.3可精简的注释内容 11 5.3.4推荐的注释内容 11 5.3.5 Null的规约 11 5.3.6 特殊代码注释 12 6. 声明 12 6.1 每行声明变量的数量 12 6.2 初始化 12 6.3 布局 12 6.4 类和接口的声明 13 6.5 声明规则 14 7. 语句 14 7.1 简单语句 14 7.2 复合语句 14 7.3 返回语句 14 7.4 if，if-else，if else-if else语句 15 7.5 for语句 15 7.6 while语句 16 7.7 do-while语句 16 7.8 switch语句 16 7.9 try-catch语句 16 8. 空白 17 8.1 空行 17 8.2 空格 17 9. 命名规范 18 9.1 命名规则 19 9.1.1 包命名 19 9.1.2 类、接口命名 19 9.1.3方法命名 19 9.1.4变量命名 20 9.1.5常量命名 20 10. 编程惯例 20 10.1 提供对实例以及类变量的访问控制 20 10.2 引用类变量和类方法 20 10.3 常量 20 10.4 变量赋值 21 10.5 异常处理 21 10.6 其它惯例 21 10.6.1 圆括号 21 10.6.2 返回值 21 10.6.3 条件运算符“?”前的表达式* 22 11. 信息输出 22 12. 代码范例 22 12.1 Java源文件范例 22 1. 介绍 1.1 为什么要有编码规范 编码规范对于程序员而言尤为重要，有以下几个原因：一个软件的生命周期中，80%的花费在于维护几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品1.2 注意事项 本文档未特别标注的都必须遵守(不遵守将代表代码不合格，会给团队其他成员带来不便和困扰，大大提高总体维护成本) 2. 文件名 这部分列出了常用的文件名及其后缀。 2.1 文件后缀 Java程序使用下列文件后缀：文件类别 文件后缀 Java源文件 .java Java字节码文件 .class JSP文件 .jsp XML文件 .xml 资源文件 .properties 日志文件 .log Tag lib文件 .tld Java 包文件 .jar 层叠样式表文件 .css 2.2 常用文件名 常用的文件名包括：文件名 用途 Build.xml Ant 编译配置 Web.xml 的配置文件 Server.xml Tomcat的配置文件 perties Log4j配置文件 hibernate.cfg.xml Hibernate配置文件 ApplicationRperties 程序的英文资源文件 ApplicationResources_zh_CN.properties 程序的gbk资源文件 struts-config.xml Struts配置文件 applicationContext-.xml Spring配置文件 3. 文件组织 一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。Java源文件范例提供了一个布局合理的Java程序范例。 3.1 Java源文件 每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共