没有合适的资源?快使用搜索试试~ 我知道了~
java编程规范.pdf
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
5星 · 超过95%的资源 1 下载量 131 浏览量
2021-10-02
11:52:18
上传
评论
收藏 180KB PDF 举报
温馨提示
试读
21页
java编程规范.pdf
资源推荐
资源详情
资源评论
JAVA 编程规范
JAVA 编程规范
- i -
目 录
目 录 ........................................................................................................................................... I
1. 命名规则 .......................................................................................................................................1
1.1 包与类命名 .............................................................................................................................1
1.1.1 包结构与类名前缀 ...........................................................................................................1
1.1.2 类命名 ..............................................................................................................................1
1.2 变量命名 .................................................................................................................................2
1.2.1 简单数据类型 ..................................................................................................................2
1.2.2 类实例命名 ......................................................................................................................2
1.2.3 枚举数据常量 ..................................................................................................................3
1.3 类方法命名 .............................................................................................................................3
1.3.1 存取类型的类方法命名 ...................................................................................................3
1.3.2 一般类型的类方法命名 ...................................................................................................3
2. 源程序结构 ...................................................................................................................................4
3. PACKAGE 区 ...............................................................................................................................4
4. 系统 IMPORT 区 .........................................................................................................................4
5. 用户 IMPORT 区 .........................................................................................................................4
6. 类说明 ..........................................................................................................................................5
7. 类成员属性定义 ...........................................................................................................................6
8. 类方法定义 ...................................................................................................................................7
8.1 类方法说明 .............................................................................................................................7
8.2 类方法实现部分编程规范 .......................................................................................................8
8.2.1 程序注释的形式 ...............................................................................................................8
8.2.2 局部变量 ..........................................................................................................................9
8.2.3 语句块 ..............................................................................................................................9
8.2.4 条件判断 if …else …..........................................................................................................9
8.2.5 条件判断 switch …case…default …..................................................................................10
8.2.6 循环控制语句 ................................................................................................................ 11
8.2.7 方法调用 ........................................................................................................................ 11
8.2.8 编程风格的要求 ............................................................................................................. 12
9. 编写类和方法时的一些约定 ...................................................................................................... 15
10. 文档化 ....................................................................................................................................... 17
11. 附录 .......................................................................................................................................... 18
11.1 本系统常用单词表 .............................................................................................................. 18
11.2 参考资料 ............................................................................................................................. 19
JAVA 编程规范
- 1 -
1. 命名规则
1.1 包与类命名
1.1.1 包结构与类名前缀
为了便于管理Java开发的应用,Java开发的应用包命名要求带有前缀 com,
采用“com.包名. 子功能包名”的形式,如com.bcl表示基础工具包。在日常项目
应用中积累的公共的内容希望能够形成通用的工具包, 供项目组使用, 工具包与
应用包同级,采用“com.应用包名. 子应用包名”的形式来组织项目开发的程序
代码。
包名和子功能包名要求具有实际的意义,从单词或缩写上能够看出包的意
义,如 “com.bcl”表示基础工具组件的包,纳入公司的基础构件库进行管理,
应用的包由项目组自己命名,命名的意义与具体的项目应用的意义相符。
1.1.2 类命名
(1) 类名首字母应该大写,字段、方法以及对象(句柄)的首字母应小写。对于
所有标识符, 其中包含的所有单词都应紧靠在一起, 而且将中间单词的首字
母大写。
例如:
ThisIsAClassName
thisIsMethodOrFieldName
若在定义中出现了常数初始化字符,则大写 static final 基本类型标识符中
的所有字母。这样便可标志出它们属于编译期的常数。
Java包(Package)属于一种特殊情况:它们全都是小写字母,即便中间的
单词亦是如此。对于域名扩展名称,如 com,org,net或者edu等,全部都应小写
(这也是Java 1.1 和Java 1.2 的区别之一)。
(2) 一行不要超过 80 个字符,并要注意折行时的写法。下面是例子:
someMethod(longExpression1, longExpression2, longExpression3,
longExpression4, longExpression5);
var = someMethod1(longExpression1,
JAVA 编程规范
- 2 -
someMethod2(longExpression2,
longExpression3));
1.2 变量命名( Attributes/Properties)
在本规则中,变量表示一个类属性 (Attribute/Property ) 或一个类方法中
的变量。变量可以是简单数据类型,如整数或浮点数,也可以是一个对象,如客
户帐户、操作员等。
本变量命名规则还包括一类特殊的变量:枚举数据常量。
1.2.1 简单数据类型
循环计数器在不影响程序可读性的前提下,可以使用传统的变量命名方式,
如i 、m、n等。
除计数器以外的简单数据类型的变量由小写字母前缀 +大写字母起头的英文
单词(或单词缩写)组成。当然,循环计数器也可以使用这种命名方式,如
nLoopCounter。
数组在变量名前缀后加数组前缀“ a”。
简单数据类型前缀表:
数据类型 变量名前缀 例子
boolean b bCustomExist, baCustomExist
char c cSymbol, caSymbols
byte y yByte, yaBytes
short s sHour, saHours
int n nLen, nLoopCounter, naLength
long l lMemory, laTimes
float f fLength, faLength
double d dMile, daMiles
注: byte 与 int 类型的前缀较特殊,使用时应注意
1.2.2 类实例命名
类实例采用以下两种命名方法:
1.对于可以使用单个单词表示并且该单词与类名一致(不含类名的前缀)
的类实例,可以使用全部是小写字母的实例名。例如 operator (类WFOperator
的实例)、task (类WFTask的实例)、date(类Date的实例)。
2.其它情况下使用以小写字母表示的类名(也可以是类名的缩写)和以大
写 字 母 起 始 的 名 称 组 成 的 标 识 名 。 例 如 strOperatorName 、 dateStart 、
JAVA 编程规范
- 3 -
customerList 。常用的类名缩写如下表:
类 类名缩写 例子
Exception e e, eAllException
SSBusiException be be, beLowBalance
SSDbAccess dba dba, dbaManagement, dbaCIF
SSLogiException le le, leInvalidValue
String str strOperatorName, strAddress
WFOperator op opCustomerManager, opDepartmentManager
3.类实例数组或集合的命名,可以在前两种情况的基础上用单词的复数形
式表示,如tasks 、opDepartmentManagers,也可以在变量前面加前缀“ some”
表示,如someTask、someOperator。
1.2.3 枚举数据常量
枚举数据常量由表示枚举类型的前缀和常量名称组成。 前缀全部由小写字母
组成,名称使用大写字母起头的英文单词。
例如交易类型的枚举常量命名如下:
不明交易类型 requestUnknown
菜单请求
requestMenuPrepare
任务准备 requestTaskPrepare
任务提交 requestTaskProcess
提交
requestReverseProcess
登录
requestLogin
系统应用准备 requestSysAppPrepare
系统应用提交 requestSysAppProcess
1.3 类方法命名
1.3.1 存取类型的类方法命名
对于直接操作类属性的方法,命名使用前缀“ get”、“is ”和“set ”表示
存或取类属性,后跟大写字母起头的英文单词。
示例如下:
Field Type Gettername Settername
firstName String getFirstName() setFirstName()
address SurfaceAddress object getAddress() setAddress()
persistent Boolean isPersistent() setPersistent()
customerId Int getCustomerId() setCustomerId()
orderItems Array of OrderItem objects getOrderItems() setOrderItems()
1.3.2 一般类型的类方法命名
使用“动词”+“名词短语”的命名格式,其中动词使用小写字母。例如
剩余20页未读,继续阅读
资源评论
- CuzYmeHnk2022-06-08用户下载后在一定时间内未进行评价,系统默认好评。
资料大全
- 粉丝: 14
- 资源: 26万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功