没有合适的资源?快使用搜索试试~ 我知道了~
java编程规范,包含命名、代码格式、代码优化、注释等
需积分: 5 0 下载量 101 浏览量
2022-10-26
11:50:27
上传
评论
收藏 180KB DOCX 举报
温馨提示
试读
13页
java编程规范,包含命名、代码格式、代码优化、注释等
资源推荐
资源详情
资源评论
系统名称 编程规范
1
目录
一 命名规范 ....................................................................................................................................2
1 基本的规则 ..........................................................................................................................2
2 常量命名 ..............................................................................................................................2
3 变量命名 ..............................................................................................................................2
4 方法命名 ...............................................................................................................................3
5 类和接口的命名 ..................................................................................................................4
6 包的命名 ..............................................................................................................................4
二、代码格式 ..................................................................................................................................4
1 注释类型 ..............................................................................................................................4
2 注释内容 ..............................................................................................................................4
3 注释格式 ..............................................................................................................................6
4 注释规范 ..............................................................................................................................7
三 文件组织 ....................................................................................................................................8
1 书写顺序和规范 ..................................................................................................................8
四 代码优化 ....................................................................................................................................9
1 代码大小 ..............................................................................................................................9
2 方法 ......................................................................................................................................9
3 属性和变量 ..........................................................................................................................9
4 代码格式 ............................................................................................................................10
5 字符串处理 ........................................................................................................................11
6 循环 ....................................................................................................................................11
7 switch 语句..........................................................................................................................11
8 异常 ....................................................................................................................................12
9 日志和调试信息 ................................................................................................................12
10 java.util 包的使用注意......................................................................................................13
系统名称 编程规范
2
一 命名规范
1 基本的规则
字符集在 26 个英文字母、0 到 9 的阿拉伯数字和下划线之中。Java 中类、字
段、方法、变量、常量尽量用字母表达,没有特别的理由不能用任何的其他
字符。
命名需要有一定的意义,推荐采用问题域中的术语命名,使命名在一定程度
上是自描述的。
命名尽量的短,如果命名太长,可以采用别名的方式,或者缩写来简化命名。
缩写一定要有意义,而且需要在整个项目中维护这些缩写的意义。
名称缩写的规则(对于类名、字段名、变量名称、模块名称等适用)
删除所有的原音字母,压缩重复字母。如 button,缩写为 btn。
如发生命名冲突,则在某一缩写中保留原音。如 batton,为了不与 button 冲
突,缩写为 batn。
不要用前导下划线,也不要在命名的末尾用下划线
2 常量命名
所有的字符都必须大写。采用有意义的单词组合表达,单词与单词之间以
“_”下划线隔开。
命名尽量简短,不要超过 16 个字符。
程序开发中最好不要直接对 literal 进行工作,最好引入常量方式应用;只有
在特别的情况下才能使用, 如在 for 循环中初始化变量时可直接用-1,0,1 这
些常量。
3 变量命名
变量的命名包括实例变量,静态变量,函数参数的命名。
系统名称 编程规范
3
避免在命名中采用数字,除非命名意义明确,程序更加清晰,对实例变量的
命名中不应该有数字。 变量名称是名词意义。
采用有符合问题域意义的单词或单词组合。第一个单词全部小写,后续的每
个单词采用首字母大写,其余小写(特殊单词除外,如 URL)。
命名尽量简短,不要超过 16 个字符。
除了生命周期很短的临时变量外,避免采用单字符作为变量名,实例变量的
命名不要用单字符。常用的单字符变量如整型用 i、j、 k、 m、 n 字符型
用 c、d、 e,坐标用 x、y、z。
在某些情况下,变量可能需要加上类型前缀,所有的类型前缀必须是小写,
他与变量名称的实体部分没有任何间隔,实体部的每个单词都是首字母大写,
其余字母小写(特殊单词除外如 URL),一般的类型前缀如下:
类型前缀
类型
例子
str
字符串(String, StringBuffer)
strFileName
ary
数组
aryName
conn
连接
connActiveConnection
stmt
Statement
stmtFindUser
rs
Resultset
rsUsers
col
Collection
colNames
msg
消息
msgText
err
错误
errCode
btn
按钮
btnSubmit
4 方法命名
命名多数为动词结构。
采用有符合问题域意义的单词或单词组合。第一个单词采用小写,后续的每
个单词采用首字母大写,其余小写(特殊字除外如 URL),没有特别理由不用
下划线作为分隔符。
在 Java 中对属性方法命名遵循 JavaBean 的标准:
getter 方法: get+属性名, 对 boolean 型采用 is+属性名,有些特定的属性
名用 has, can 代替 is 可能更好。
setter 方法: set+属性名
剩余12页未读,继续阅读
资源评论
huixiyang
- 粉丝: 0
- 资源: 3
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功