没有合适的资源?快使用搜索试试~ 我知道了~
资源详情
资源评论
资源推荐
Java 编码规范
目 录
.1 引言 ..................................................................................................................1
1.1 为什么要有编码规范................................................................................1
2 命名规范 ..........................................................................................................1
2.1 文件名 ................................................................................................1
2.2 包(P
ackages) ......................................................................................1
2.3 类(Classes)
.........................................................................................1
2.4 接口(Inte
rfaces) ..................................................................................1
2.5 方法(M
ethods).....................................................................................1
2.6 变量(V
ariables)....................................................................................1
2.7 常量(Constants)
...................................................................................2
2.8 参数(P
arameters).................................................................................2
2.9 数组(Arr
ays) .......................................................................................2
3 文件组织内容编排 ...............................................................................................2
3.1 Java源文件组织 ....................................................................................2
3.2 开头注释 .............................................................................................2
3.3 缩进排版 .............................................................................................3
4 注释规范(Comments)
.........................................................................................4
4.1 实现注释的格式 .....................................................................................5
4.2 文档注释 .............................................................................................6
5 编码格式规范 .....................................................................................................7
5.1 声明(De
clarations) ...............................................................................7
5.2 语句(State
ments) ................................................................................8
5.3 空白.................................................................................................10
6 编程惯例 ........................................................................................................11
6.1 提供对实例变量以及类变量的访问控制........................................................11
6.2 引用类变量和类方法..............................................................................11
6.3 常量.................................................................................................11
6.4 变量赋值 ...........................................................................................11
6.5 其它惯例 ...........................................................................................12
7 代码范例(Cod
e Examples).................................................................................13
7.1 Java源文件范例(Ja
va Source File Example) .............................................13
第 1 页 共 21 页
.1 引言
1.1 为什么要有编码规范
编码规范对于程序员而言尤为重要,有以下几个原因:
z 一个软件的生命周期中,80
%的花费在于维护;
z 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护;
z 编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码;
z 如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误;
z 增加程序的可读性、易维护性、重用性,减少代码的错误发生率;
z 为了使应用程序的结构和编码风格标准化,便于阅读和理解编码,每个软件开发人员必须一致遵守
编码规范。
2 命名规范
命名规范使程序更易读,
从而更易于理解。它们也可以提供一些有关标识符功能的信息,以助于理解代码,
不允许使用汉语拼音命名,一律用有意义的英文名字,命名规范适用于如常量,包,类等。
2.1 文件名
Ja
va 程序使用下列文件后缀:
文件类别 文件后缀
Java 源文件
.java
Java 字节码文件
.class
2.2 包(Packages)
一个唯一包名的前缀总是全部小写,使用 com.capinfo 或 capinfo 作为所有包的前缀。例如:
com.capinfo.web.action 或 capinfo.web.action。
2.3 类(Classes)
类名是个名词,
采用大小写混合的方式,每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用
完整单词,避免缩写词(除非该缩写词被更广泛使用,像 URL,HTML) 。例如:class Customer;class
BankAccount。
2.4 接口(Int
erfaces)
Interface 名可以是一个名词或形容词(加上'able','ible', or 'er'后缀),如 Runnable,Accessible。大
小写规则与类名相似,例如: interface StatusEnabled。
2.5 方法(Met
hods)
方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。 例如:
execute(); getProperty()。
2.6 变量(Variabl
es)
变量名均采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。变量名不应以下划
第 2 页 共 21 页
线或美元符号开头。变量名应简短且富于描述。变量名的选用应该易于记忆,即,能够指出其用途。尽量避免
单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为 i,j,k,m 和 n,它们一般用于整型;
c,d,e,它们一般用于字符型。例如:char c;int i;float myWidth。
2.7 常量(Consta
nts)
类常量的声明,应该全部大写,单词间用下划线隔开。例如:static final int MIN_WIDTH = 4;static final
int MAX_WIDTH = 999;static final int GET_THE_CPU = 1。
2.8 参数(Parameters)
参数的名字和变量的命名规范一致。
2.9 数组(A
rrays)
数组应该总是用下面的方式来命名:byte[] buffer;而不是:byte buffer[]。
3 文件组织内容编排
一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过 200
0行的程序难以阅读,
应该尽量避免。
3.1 Java源文件组织
每个 Ja
va 源文件都包含一个单一的公共类或接口。若嵌套类和接口与一个公共类相关联,可以将它们和
公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。
Java 源文件还遵循以下规则:
z 开头注释(参见"开头注释")
z 包和引入语句(参见"包和引入语句")
z 类和接口声明(参见"类和接口声明")
3.2 开头注释
所有的源文件都应该在开头有一个 C 语言
风格的注释,其中列出类名、版本信息、作者、日期和版权声明:
/*
* ClassName
*
* Version Information
*
* Author
*
* Date
*
* Copyright notice
*/
1)包和引入语句(Package and Import Statements)
在多数 Java 源文件中,第一个非注释行是包语句。在它之后可以跟引入语句。例如:
剩余16页未读,继续阅读
玥舞神
- 粉丝: 0
- 资源: 11
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0