LiEMS3.0系统 JAVA编码规范
南京朗坤软件有限公司
?2004年 南京朗坤自动化有限公司 版权所有
机密文档，未经授权，不得外传
JAVA编码规范
文档类型:
编码规范
作者: 技术平台小组
南京朗坤软件有限公司
日期: 版本: 客户:
发布人员:
1.0
2004 年 8 月 31 日
南京市江宁区铜山金铜路2号 211156
电话: +86 25 86192500 传真: +86 25 86192503 Web: http://www.luculent.net
文档审核:
文档批准:
: : :
_________________________ _______年___月___日
_________________________ _______年___月___日
_________________________ _______年___月___日
南京朗坤软件有限公司 第2/48页
JAVA编码规范
修正记录
版本 1.0 日期 2004-8-31 作者 技术平台小组 修改描述 初稿
南京朗坤软件有限公司 第3/48页
JAVA编码规范
目 录
1
概述 ................................................................................................................................................. 7
1.1 1.2 1.3
背景 ............................................................................................................................................... 7 读者对象 ....................................................................................................................................... 7 商讨 ............................................................................................................................................... 7
2 基本原则 ......................................................................................................................................... 8
2.1 2.2 2.3 2.4 2.5
一开始就必须正确的使用规范 .................................................................................................... 8 简易性原则 ................................................................................................................................... 8 清晰性原则 ................................................................................................................................... 8 健壮性原则 ................................................................................................................................... 8 效率原则 ....................................................................................................................................... 8
3 格式规范 ......................................................................................................................................... 9
3.1 3.2 3.3 3.4 3.5
代码缩进 ....................................................................................................................................... 9 分解较长的行 ............................................................................................................................... 9 空白区域的使用 .......................................................................................................................... 11 不经常使用TAB ......................................................................................................................... 14 SQL语句书写规范 ..................................................................................................................... 14
4 命名规范 ....................................................................................................................................... 18
4.1 4.2 4.3 4.4 4.5 4.6 4.7
使用有意义的命名 ..................................................................................................................... 18 使用术语进行命名 ..................................................................................................................... 18 超长命名处理 ............................................................................................................................. 18 保留元音 ..................................................................................................................................... 19 缩写后的首字母大写 ................................................................................................................. 19 不要用字符的大小写来区分命名 .............................................................................................. 19 包命名 ......................................................................................................................................... 19
包命名 ................................................................................................................................. 19 4.7.2 使用单一的、小写单词来命名每一个包 ......................................................................... 20 4.8 类命名 ......................................................................................................................................... 20 4.8.1 类或接口的每个单词的首字母大写 ................................................................................. 20 4.8.2 使用名词来命名类 ............................................................................................................. 20 4.8.3 一组有关系的属性、静态服务或常量的类命名采用复数 .............................................. 20 4.9 接口命名 ..................................................................................................................................... 21 4.9.1 使用名词或形容词来命名接口 ......................................................................................... 21 4.10 方法的命名 ................................................................................................................................. 22 4.10.1 方法的首单词的首字母小写，后面的单词的首字母大写 .............................................. 22 4.10.2 使用动词来命名方法 ......................................................................................................... 22 4.10.3 遵从JavaBeans规则来命名访问方法 .............................................................................. 23 4.11 变量命名 ..................................................................................................................................... 23 4.11.1 在变量的命名中，变量的首单词的首字母小写，后面的单词的首字母大写 .............. 23 4.11.2 使用名词来命名变量 ......................................................................................................... 24
南京朗坤软件有限公司 第4/48页
4.7.1
JAVA编码规范
集合含义的变量采用复数形式进行命名 ......................................................................... 24
4.11.4 建立一套标准的临时使用的变量规则 ............................................................................. 24 4.12 属性命名 ..................................................................................................................................... 25 4.12.1 使用“this”关键字限定属性变量，用于区分逻辑变量 ................................................ 25 4.13 参数命名 ..................................................................................................................................... 25 4.13.1 当一个构件器或一个“set”方法通过参数赋值给一个属性时，将参数和属性采用同样的名字来命名 .............................................................................................................................. 25 4.14 常量命名 ..................................................................................................................................... 26
4.11.3
5 注释规范 ....................................................................................................................................... 27
5.1 5.2 5.3 5.4 5.5 5.6 5.7 5.8
保持注释和代码同步 ................................................................................................................. 27 使用主动语态并尽量忽略不需要的用词 .................................................................................. 27 注释类型 ..................................................................................................................................... 27 版权信息注释 ............................................................................................................................. 27 使用文档注释来描述程序接口 .................................................................................................. 28 使用标准代码去隐藏代码而不要删除它 .................................................................................. 29 使用行注释来解释实现细节 ...................................................................................................... 29 文档注释 ..................................................................................................................................... 30
在代码编写前就描述程序接口 ......................................................................................... 30 5.8.2 文档中应描述公有、保护、包和私有的成员 ................................................................. 30 5.8.3 对每个包提供概要描述信息和总体的功能 ..................................................................... 30 5.8.4 对每个应用或一组包提供概要描述信息和总体的功能 .................................................. 30 5.9 注释格式 ..................................................................................................................................... 31 5.9.1 在所有的文档注释中，使用一致的格式和结构 ............................................................. 31 5.10 使用第三人称代词 ..................................................................................................................... 31 5.11 使用“THIS”而不是“THE”指向当前类的实例 ............................................................................. 31 5.12 不要在方法或构造函数名后添加“（）”，除非做一个特殊的标识 ........................................ 32 5.13 注释内容 ..................................................................................................................................... 32 5.13.1 为每一个类、接口、属性和方法提供一个概要描述 ...................................................... 32 5.13.2 充分描述每个方法提供的操作 ......................................................................................... 32 5.13.3 解释和理解你的软件的使用，最简单的方法是提供例子。 .......................................... 32 5.14 以文档方式记录已知的缺点和不足 .......................................................................................... 33 5.15 记录同步的语义 ......................................................................................................................... 33 5.16 代码内部注释 ............................................................................................................................. 34 5.16.1 需要帮助他人理解代码时才增加内部注释 ..................................................................... 34 5.16.2 描述代码应该做的事情，而不是描述代码正在做什么 .................................................. 34 5.16.3 避免使用行末注释的方法 ................................................................................................. 34 5.16.4 采用行末注释的方式解释局域变量 ................................................................................. 34 5.16.5 创建并使用一套关键字集来标注未解决的问题 ............................................................. 34 5.16.6 在多重嵌套控制结构中标注结束标志 ............................................................................. 35 5.16.7 如果在switch语句中没有break，则在相应的两个case之间添加一行“fall-through”注释 35
5.16.8 标注empty语句.................................................................................................................. 36
5.8.1
6 编程规范 ....................................................................................................................................... 37
南京朗坤软件有限公司 第5/48页