没有合适的资源?快使用搜索试试~ 我知道了~
资源详情
资源评论
资源推荐
raw.doc Ver. 0.1
Java 编码规范
2008-7-8
1 概述.........................................................................................................................................................2
1.1 背景.................................................................................................................................................2
1.2 目标.................................................................................................................................................2
1.3 范围.................................................................................................................................................2
1.4 参考资料.........................................................................................................................................2
2 代码编写基本要求.................................................................................................................................3
2.1 程序结构要求.................................................................................................................................3
2.2 可读性要求.....................................................................................................................................3
2.3 正确性与容错性要求.....................................................................................................................5
2.4 可重用性要求.................................................................................................................................6
3 注释.........................................................................................................................................................6
3.1 实现注释的格式(IMPLEMENTATION COMMENT FORMATS)............................................................6
块注释
(Block Comments)..................................................................................................................6
单行注释
(Single-Line Comments)....................................................................................................7
尾端注释
(Trailing Comments)..........................................................................................................7
行末注释
(End-Of-Line Comments)..................................................................................................7
3.2 文档注释(DOCUMENTATION COMMENTS).......................................................................................8
4 命名规范.................................................................................................................................................8
5 代码范例...............................................................................................................................................10
- 1 -
raw.doc Ver. 0.1
1 概述
1.1 背景
编码规范对于负责软件开发和维护的程序员,对于应用软件的后续开发和维护,以及
提高公司的技术服务的质量等都极为重要,主要有以下几个原因:
软件的生命周期中,的花费在于维护。
对于我们的绝大部分软件,在其整个生命周期中,不可能由最初的开发人员来维
护。
规范编码可以减少代码的错误。
编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码。
1.2 目标
这份文档对使用 Java 开发的应用程序,在最基本的代码编写、程序注释和命名规则方
面提出了明确的规范。这份编码规范的的目标有:
通过提高程序的可读性、一致的风格以及其它设计原则来提高程序的可维护性,
降低维护成本。
提高程序的质量,避免错误。
1.3 范围
本规范适应于所有 Java 开发的应用程序的注释和命名,包括 Servlet 和 JSP,更为详细
的编码规范请参看 1.4 节的有关资料。
1.4 参考资料
http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
- 2 -
raw.doc Ver. 0.1
2 代码编写基本要求
2.1 程序结构要求
应避免在一个文件中放入多个类。
一个代码文件一般不超过行,不要手动修改机器产生的代码。
程序结构清晰,简单易懂,单个函数的程序行数一般不得超过行。
一个代码行不要超过个字符长度。
变量和方法的命名要具有可读性。
不要随意定义全局变量,尽量使用局部变量。
类和接口声明的各个部分以及它们出现的先后次序如下表。参见“代码范例”中的例子。
类/接口声明的各部分 注解
类接口文档注释 ! 该注释中所需包含的信息,参见"文档注释"
#
类或接口的声明
$
类接口实现的注释 !
如果有必要的话
该注释应包含任何有关整个类或接口的信息,
而这些信息又不适合作为类接口文档注释。
%
类的静态!变量
首先是类的公共变量,随后是保护变量,再后
是包一级别的变量没有访问修饰符,
&!,最后是私有变量。
实例变量
首先是公共级别的,随后是保护级别的,再后
是包一级别的没有访问修饰符!,最后是私有
级别的。
'
构造器
(
方法
这些方法应该按功能,而非作用域或访问权
限,分组。例如,一个私有的类方法可以置于
两个公有的实例方法之间。其目的是为了更便
于阅读和理解代码。
2.2 可读性要求
程序要采用缩进风格编写,包括函数的开始、结构的定义及循环、判断等语句中的代
码等等,缩进的空格数为%个。
不允许把多个短语句写在一行中,每行至多包含一条语句,例如:
))*正确
++*正确
))*++*应避免
- 3 -
剩余10页未读,继续阅读
chenbing3313
- 粉丝: 10
- 资源: 13
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0