没有合适的资源?快使用搜索试试~ 我知道了~
Java项目编码规范.pdf
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 52 浏览量
2021-10-04
18:46:16
上传
评论
收藏 46KB PDF 举报
温馨提示
试读
21页
Java项目编码规范.pdf
资源推荐
资源详情
资源评论
Java 编码规范
V1.0
2010 年 8 月 3
目录
1 介绍 .............................................................................................................................................. 5
1.1 为什么要有编码规范 ........................................................................................................ 5
1.2 参考资料 ............................................................................................................................ 5
2 文件名 ........................................................................................................................................... 5
2.1 文件命名 ............................................................................................................................ 5
2.2 文件后缀 ............................................................................................................................ 5
3 文件组织 ....................................................................................................................................... 5
3.1 Java 源文件长度 ................................................................................................................ 6
3.2 Java 源文件结构 ................................................................................................................ 6
3.2.1 开头注释 ................................................................................................................. 6
3.2.2 包和引入语句 ......................................................................................................... 6
3.2.3 类和接口声明 ......................................................................................................... 6
4 缩进排版 ....................................................................................................................................... 7
4.1 行长度 ................................................................................................................................ 7
4.2 换行 .................................................................................................................................... 7
5 注释 .............................................................................................................................................. 8
5.1 实现注释的格式 ................................................................................................................ 8
5.1.1 块注释 ..................................................................................................................... 8
5.1.2 单行注释 ................................................................................................................. 9
5.1.3 尾端注释 ................................................................................................................. 9
5.1.4 行末注释 ................................................................................................................. 9
5.2 文档注释的格式 .............................................................................................................. 10
5.3 类/接口注释的内容 ......................................................................................................... 10
5.4 方法注释的内容 .............................................................................................................. 10
6 声明 ............................................................................................................................................ 11
6.1 每行声明变量的数量 ...................................................................................................... 11
6.2 初始化 .............................................................................................................................. 11
6.3 布局 .................................................................................................................................. 11
6.4 类和接口的声明 .............................................................................................................. 12
7 语句 ............................................................................................................................................ 13
7.1 简单语句 .......................................................................................................................... 13
7.2 复合语句 .......................................................................................................................... 13
7.3 返回语句 .......................................................................................................................... 13
7.4 If, if-else, if else-if else 语句 ........................................................................................... 13
7.5 for 语句 ............................................................................................................................ 14
7.6 while 语句 ........................................................................................................................ 14
7.7 do-while 语句 .................................................................................................................. 14
7.8 switch 语句 (switch Statements) ....................................................................................... 14
7.9 try-catch 语句 .................................................................................................................. 15
8 空白 ............................................................................................................................................ 15
8.1 空行 .................................................................................................................................. 15
8.2 空格 .................................................................................................................................. 15
9 命名规范 ..................................................................................................................................... 16
10 编程惯例 ................................................................................................................................... 17
10.1 提供对实例以及类变量的访问控制 ............................................................................ 17
10.2 引用类变量和类方法 .................................................................................................... 17
10.3 常量 ................................................................................................................................ 17
10.4 等值比较 ........................................................................................................................ 17
10.5 变量赋值 ........................................................................................................................ 18
10.6 数组定义 ........................................................................................................................ 18
10.7 其它惯例 ........................................................................................................................ 18
10.7.1 圆括号 .................................................................................................................. 18
10.7.2 返回值 .................................................................................................................. 19
10.7.3 条件运算符 "?"前的表达式 ................................................................................. 19
10.7.4 特殊注释 .............................................................................................................. 19
11 源文件范例 ............................................................................................................................... 19
11.1 Java 源文件范例 ............................................................................................................ 19
1 介绍
1.1 为什么要有编码规范
编码规范对于程序员而言尤为重要,有以下几个原因:
一个软件的生命周期中, 80%的花费在于维护
几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护
编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码
为了执行规范,每个软件开发人员必须一致遵守编码规范。
1.2 参考资料
本文档主要参考了 Sun MicroSystems 公司, Java 语言规范中的编码标准部分。 参考链
接: http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
2 文件名
2.1 文件命名
文件命名与该文件包含的公共类或者接口名字相同。
2.2 文件后缀
Java 程序使用下列文件后缀:
Java 源文件: .java
Java 编译后的字节码文件: .class
MANIFEST.MF :.MF,包配置的说明文件。
XML 配置文件: .xml
属性配置文件: .property
Jar 文件: .jar
3 文件组织
一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。 第 11 章的
剩余20页未读,继续阅读
资源评论
maodi_lzc
- 粉丝: 1
- 资源: 4万+
下载权益
C知道特权
VIP文章
课程特权
开通VIP
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功