Java代码编写规范 下载本文

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