一、 概述

（一） 背景

（二） 读者对象

（三） 商讨

二、 基本原则

（一） 一开始就必须正确的使用规范

（二） 简易性原则

（三） 清晰性原则

（四） 健壮性原则

（五） 效率原则

三、 格式规范

（一） 代码缩进

（二） 分解较长的行

（三） 空白区域的使用

（四） SQL语句书写规范

四、 命名规范

（一） 使用有意义的命名

（二） 使用术语进行命名

（三） 超长命名处理

（四） 保留元音

（五） 缩写后的首字母大写

（六） 不要用字符的大小写来区分命名

（七） 包命名

（八） 类命名

（九） 接口命名

（十） 方法的命名

（十一） 变量命名

（十二） 属性命名

（十三） 参数命名

（十四） 常量命名

五、 注释规范

（一） 保持注释和代码同步

（二） 使用主动语态并尽量忽略不需要的用词

（三） 注释类型

（四） 版权信息注释

（五） 使用文档注释来描述程序接口

（六） 使用标准代码去隐藏代码而不要删除它

（七） 使用行注释来解释实现细节

（八） 文档注释

（九） 注释格式

（十） 使用第三人称代词

（十一） 使用“this”而不是“the”指向当前类的实例

（十二） 不要在方法或构造函数名后添加“（）”，除非做一个特殊的标识

（十三） 注释内容

（十四） 以文档方式记录已知的缺点和不足

（十五） 记录同步的语义

（十六） 代码内部注释

六、 编程规范

（一） 将代表基础数据类型的类声明为final

（二） 定义类和方法尽可能短小精悍

（三） 将所有成员变量声明为private类型

（四） 使用多态(polymorphism)，不使用isntanceOf

（五） 类型安全

（六） 语句与表达式

（七） 构造函数

（八） 异常处理

程序编码是一项极具创造性的任务，它虽然鼓励思维的自由翱翔，但同时也必须遵循一定的原则与约束。编码风格对于软件项目的开发而言，其重要性不言而喻。

本系统基于Java语言和J2EE技术框架进行开发。为了统一Java编码标准、提升编码质量、加强代码的可读性和可维护性，我们特别制定了以下编码规范。

开发工程师在开发过程中必须严格遵守本规范，它不仅是代码编写的准则，也是代码验收等管理环节必须遵循的标准。