Java语言编码规范要点.doc

SPSG安全产品服务部 Java语言编码规范 V1.0.0  姓名、签字 日期 编 制 审 核 批 准 更改历史 版本号 编制 发布日期 更改原因 更改内容 目　　录 1.前言 5 1.1 适用范围 5 1.2 执行时间 5 1.3 罚则 5 1.4 建议读物 5 2. JAVA语言 5 2.1 布局结构规范 5 2.1.1 一般规则 5 2.1.2 源文件结构 6 2.1.3 类头部说明 7 2.1.4 方法头部说明 8 2.1.5 目录结构 10 2.2 书写排版规范 10 2.2.1 一般规则 11 2.2.2 类的头（Class Headers） 11 2.2.3 方法的头（Method Headers） 11 2.2.4 缩进 11 2.2.5 空格 11 2.2.6 空行 12 2.2.7 括号和回车 12 2.2.8 对齐 12 2.2.9 长行拆分 13 2.3 命名规范 13 2.3.1 一般规则 13 2.3.2 包的命名（Package Names） 14 2.3.3 类的命名（Class Names） 14 2.3.4 对象（类实例）的命名（Object Names） 14 2.3.5 字段的命名（Field Names） 14 2.3.6 类变量的命名（Class Variables Names） 15 2.3.7 本地变量的命名（Local Variables Names） 15 2.3.8 方法的命名（Methods Names） 16 2.3.9 常量的命名（Constants Names） 17 2.3.10 异常的命名（Exceptions Names） 17 2.4 语言规范 17 2.4.1 变量 17 2.4.2 变量的初始化 19 2.4.3 方法 19 2.4.4 表达式 19 2.4.5 语句 21 2.4.6 final关键字 24 2.4.7 构造方法 24 2.4.8 注释 25 2.5 编码优化 26 2.5.1 JAVA对象 26 2.5.2 SQL语句 27 1.前言 本细则主要适用于在各种平台上用JAVA语言编写的源代码，旨在统一源代码的编码规范，增加其可读性、减少错误的发生，并最终形成良好的编码风格，特制订本规范。如有建设性意见，可以通过项目组讨论通过后，修改本规范。 注：本文中标注【规则*-*-*】的条款须严格执行，标注【建议*-*-*】的条款为提倡采用。 适用范围 本规范适用于SPSG安全产品服务部开发的所有软件产品和应用系统（合作公司人员也应遵守），在各产品（应用系统）的开发过程中，如果出现与本规范相抵触（或需要对本规范进行扩展时），必须先编制出该产品（应用系统）的开发规范，并报请部门，经批准后方能执行。 执行时间 本规范自2006年08月01日起正式实施，凡在2006年08月01日后开始发起的开发都必须严格遵守本规范。 罚则 凡是与本规范精神相抵触的开发规范，一律视为不合规范。检验人员有权要求作者按照规范要求重新编写或改正，如果因重新编写导致项目延误或者其他的后果，责任由作者承担，在重新编写代码期间，原作者必须承担正常的工作分配。 本规范的解释权属于SPSG安全产品服务部。 建议读物 JAVA语言 布局结构规范 一般规则 【规则2-1-1-1】一个源程序文件（.Java文件）应该包括一个公共类（也可以包含额外的非公共类）。 【规则2-1-1-2】每个源程序文件的头部必须包含类的头部说明和修改记录（与头部说明合并）。 【建议2-1-1-3】每个方法头部必须包含方法头部说明。 源文件结构 【规则2-1-2-1】源文件各部分的书写顺序如下： 包的名字 Package name 引进部分 Import section 类的定义 Class definition ： 类的头部说明Class header description 类的定义Class definition 常数Constants (final class variables): public, protected, private 公共的静态内部类Public static inner classes 被保护的内部类Protected inner classes, static 或其他 私有的内部类Private inner classes, static 或其他 类的变量Class variables (只有private) 字段Fields (insta