Java代码规范,java开发规范资源-CSDN文库

代码规范

5星 · 超过95%的资源需积分: 10 89 浏览量 2015-11-18 11:49:42 上传评论收藏 253KB DOC 举报

资源推荐

资源详情

资源评论

代码规范 Java 版

文件编号



文件状态 草稿 正式发布 正在修改

当前版本



拟制



日期



审核日期

批准日期

修订历史记录

A增加 M修订 D删除

变更版本号日期变更类型

（A*M*D

）

修改人摘要备注

 



 

拟制

1 / 34

.目录
.目录.........................................................................................................................................2
1 概述.......................................................................................................................................4
1.1 意义................................................................................................................................4
1.2 原则................................................................................................................................5
..1  统一............................................................................................................................5
..2  达意............................................................................................................................5
..3  简洁............................................................................................................................5
..4  骆驼法则.....................................................................................................................6
..5  英文 vs 拼音................................................................................................................6
2 文件组织...............................................................................................................................6
2.1 Java 源文件.....................................................................................................................6
..6  开头注释.....................................................................................................................7
..7  包和引入语句.............................................................................................................7
..8  类和接口声明.............................................................................................................7
..9  一个类中代码行数.....................................................................................................8
3 命名规范...............................................................................................................................9
3.1 包名................................................................................................................................9
3.2 文件名............................................................................................................................9
3.3 类名................................................................................................................................9
..10  首字母大写...............................................................................................................9
..11  后缀..........................................................................................................................9
3.4 方法名..........................................................................................................................10
3.5 域名（变量）..............................................................................................................11
..12  静态常量.................................................................................................................11
..13  枚举........................................................................................................................11
..14  一般变量.................................................................................................................12
..15  局部变量名.............................................................................................................12
 2 / 34

4 排版.....................................................................................................................................12
4.1 空白..............................................................................................................................12
..16  空行........................................................................................................................12
..17  空格........................................................................................................................13
4.2 缩进排版......................................................................................................................14
..18  行长度....................................................................................................................14
..19  换行........................................................................................................................14
5 注释.....................................................................................................................................16
5.1 注释风格......................................................................................................................16
..20  块(block).................................................................................................................16
..21  单行(single-line)......................................................................................................17
..22  尾端(trailing)...........................................................................................................17
..23  行末(end-of-line)....................................................................................................18
5.2 注释类型......................................................................................................................18
..24  源文件头注释.........................................................................................................18
..25  函数（方法）头部注释.........................................................................................19
..26  注意事项.................................................................................................................21
6 声明.....................................................................................................................................23
6.1 每行声明变量的数量...................................................................................................23
6.2 初始化..........................................................................................................................24
6.3 布局..............................................................................................................................24
6.4 类和接口的声明...........................................................................................................25
7 语句.....................................................................................................................................26
7.1 简单语句......................................................................................................................26
7.2 复合语句......................................................................................................................26
7.3 返回语句......................................................................................................................26
7.4 If 与 if-else.....................................................................................................................27
7.5 for 语句.........................................................................................................................28
7.6 while 语句.....................................................................................................................28
7.7 do-while 语句...............................................................................................................29
 3 / 34

7.8 switch 语句...................................................................................................................29
7.9 try-catch 语句...............................................................................................................30
8 编程惯例.............................................................................................................................31
8.1 提供对实例以及类变量的访问控制...........................................................................31
8.2 引用类变量和类方法...................................................................................................31
8.3 常量(Constants)............................................................................................................31
8.4 变量赋值......................................................................................................................31
8.5 其它惯例......................................................................................................................32
..27  圆括号....................................................................................................................32
..28  返回值(Returning Values).......................................................................................32
..29  条件运算符"?"前的表达式....................................................................................33
..30  特殊注释(Special Comments).................................................................................34
9 代码范例.............................................................................................................................34
1 概述
本  代码规范以  的标准  代码规范为基础，为适应我们公司的实际需要，
做一些修改和细化。本文档中没有说明的地方，请查看  公司的  标准代码规范。
1.1 意义
编码规范对于程序员而言尤为重要，有以下几个原因：
 一个软件的生命周期中，的花费在于维护；
 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护；
 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码；
 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你
已构建的其它任何产品。
 规范的代码：可提供程序员的编码水平。
 4 / 34