XL-QP-30-7-JAVA编码规范.docVIP

JAVA编码规范 版本：1.0 作者： ________________________ 日期： ______2007.12.2_________ 目录 第一章 布局结构规范 4 1.1 一般规则 4 1.2 源文件结构 4 1.3 类头部说明 5 1.4 方法头部说明 6 1.5 目录结构 7 第二章 书写排版规范 8 2.1 一般规则 8 2.2 类的头（Class Headers） 8 2.3 方法的头（Method Headers） 8 2.4 缩进 8 2.5 空格 9 2.6 空行 10 2.7 括号和回车 10 2.8 对齐 10 2.9 长行拆分 12 第三章 命名规范 13 3.1 一般规则 13 3.2 包的命名（Package Names） 14 3.3 类的命名（Class Names） 14 3.4 对象（类实例）的命名（Object Names） 14 3.5 字段的命名（Field Names） 14 3.6 类变量的命名（Class Variables Names） 15 3.7 本地变量的命名（Local Variables Names） 15 3.8 方法的命名（Methods Names） 16 3.9 常量的命名（Constants Names） 16 3.10 异常的命名（Exceptions Names） 17 第四章 语言规范 17 4.1 变量 17 4.2 变量的初始化 18 4.3 方法 18 4.4 表达式 19 4.5 语句 20 IF语句 20 Switch语句 21 循环语句 21 4.6 final关键字 22 4.7 构造方法 22 4.8 注释 23 4.9 编码优化 24 前言 本细则主要适用于在各种平台上用JAVA语言编写的源代码，旨在统一源代码的编码规范，增加其可读性、减少错误的发生，并最终形成良好的编码风格，特制订本规范。 注：本文中标注【规则*-*-*】的条款必须严格执行，标注【建议*-*-*】的条款为提倡采用。 适用范围 本规范适用于采用JAVA语言进行开发的所有软件产品和应用系统（合作公司人员也应遵守），在各产品（应用系统）的开发过程中，如果出现与本规范相抵触（或需要对本规范进行扩展时），必须先编制出该产品（应用系统）的编程规范，并报请上级部门，经批准后方能执行。 布局结构规范 一般规则 【规则1-1-1】一个源程序文件（.Java文件）应该包括一个公共类（也可以包含额外的非公共类）。 【规则1-1-2】每个源程序文件的头部必须包含类的头部说明和修改记录（与头部说明合并）。 【建议1-1-3】每个方法头部必须包含方法头部说明。 源文件结构 【规则1-2-1】源文件各部分的书写顺序如下： 包的名字 Package name 引进部分 Import section 类的定义 Class definition ： 类的头部说明Class header description 类的定义Class definition 常数Constants final class variables : public, protected, private 类的变量Class variables 只有private 字段Fields instance variables 只有private 构造器（构造方法）Constructors（含说明） 方法的定义 Method definition public, protected, private ： 方法头部说明 Method header description 方法的定义 Method definition 方法体Method body 公共的静态内部类Public static inner classes 被保护的内部类Protected inner classes, static 或其他 私有的内部类Private inner classes, static 或其他 【规则1-2-2】相关的方法应该放置在一起。 【规则1-2-3】当需要覆盖父类（superclass）的方法时，要保持这些方法和原父类的排列顺序一致，最好是放在一起。 【规则1-2-4】在引进部分（import section）应清晰地列出每一个被引进的具体类。 例如： 正确的写法： import java.applet.AppletContext; 错误的写法： import java.applet.*; 类头部说明 【规则1-3-1】类的头部说明必须包含类名、系统名称、软件版权、功能说明、作者、程序版本、各版本的修改日期和修改人员姓名、修改内容说明等几个部分，参考类为可选项。各部分次序如下： 类名 当前类的中