没有合适的资源?快使用搜索试试~ 我知道了~
Java开发规范参照.pdf
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 76 浏览量
2022-02-22
01:51:34
上传
评论
收藏 223KB PDF 举报
温馨提示
试读
30页
Java开发规范参照.pdf
资源推荐
资源详情
资源评论
文档名称
Java 开发规范
版本
2.0alpha
文档编号 日期
2010-11-25
Java 开发规范
第1章 绪论
1.1 目的
本规范的目的是使本组织能以标准的、规范的方式设计和编码。通过建立编码规范,以使每
个开发人员养成良好的编码风格和习惯;并以此形成开发小组编码约定,提高程序的可靠性、可
读性、可修改性、可维护性和一致性等,增进团队间的交流,并保证软件产品的质量。
1.2 范围
本规范适用于 “Skyinn Group ”及其下所有软件项目、产品等的设计、开发以及维护、升级
等。
本规范使用于 “Skyinn Group ”的所有软件开发人员,在整个软件开发过程中必须遵循此规
范。
1.3 版权声明
本文档为共享文档,不限转载,但请保持本文档的完整性。
您可以修改本文档以符合您或组织、公司等之实际,但请在文档中保持对本文档的引用和说
明。
未经本人授权,任何个人、组织或单位不得将本文档用于书面发表、转载、摘录等,亦不得
用于其他商业行为。
本人及本组织不承担任何因使用、参考本文档等而导致的任何可能责任或连带责任。
1.4 参考资料
《Java 编程指南》见 RUP( Rational Unified Process )中文版。
《Java 技术手册》 (Java in a Nutshell)
《Sun Java 语言编码规范》 (Java Code Conventions)
《Effictive Java 》
《Java Pitfalls 》
《Java Rules》
1.5 概述
对于代码,首要要求是它必须正确,能够按照设计预定功能去运行;第二是要求代码必须清
晰易懂,使自己和其他的程序员能够很容易地理解代码所执行的功能等。然而,在实际开发中,
每个程序员所写的代码却经常自成一套,很少统一,导致理解困难,影响团队的开发效率及系统
的质量等。因此,一份完整并被严格执行的开发规范是非常必须的,特别是对软件公司的开发团
队而言。此规范参考自业界标准编程规范并结合本人多年编程经验、习惯等而制定,在本人工作
过的公司中都曾参考本文档而形成内部开发规范并执行。现在将本文档共享之,希望能对各位有
所帮助,并做引玉之砖,希望各位朋友将自己的经验等增补进去,对我们所热爱的软件业有所裨
益。
最根本的原则:
代码虽然是给机器运行的,但却是给人读的!
运用常识。当找不到任何规则或指导方针,当规则明显不能适用,当所有的方法都失效的时
共享
第 5 页/共 5 页
文档名称
Java 开发规范
版本
文档编号 日期
2004-7-18
侯: 运用常识并核实这些基本原则。这条规则比其它所有规则都重要。常识是必不可少。
当出现该情况时,应当及时收集并提交,以便对本规范进行修改。
共享
第 6 页/共 6 页
第2章 代码组织与风格
2.1 基本原则
代码的组织和风格的基本原则是:便于自己的开发, 易于与他人的交流 。
因个人习惯和编辑器等可以设置和形成自己的风格,但必须前后一致,并符合本规范的基本
要求和原则。
本章所涉及到的内容一般都可在 Java 集成编辑环境中进行相应设置,也可由 Ant 等调用
checkstyle 等来进行自动规整。
开发工具经项目负责人调试后统一确定。
开发工具一经确定不允许集成任何非统一插件,若有需要,经项目负责人同意后统一为
项目组成员添加。
开发工具的编码格式不允许修改。
2.2 缩进
子功能块当在其父功能块后缩进。
当功能块过多而导致缩进过深时当将子功能块提取出来做为子函数。
代码中以 TAB (4 个字符)缩进,在编辑器中请将 TAB 设置为以空格替代,否则在不同编辑器
或设置下会导致 TAB 长度不等而影响整个程序代码的格式。例如:
Table1 .缩进示例
public void methodName(){
if(some condition){
for( …){
//some sentences
} //end for
} //end if
}
2.3 长度
为便于阅读和理解,单个函数的有效代码长度当尽量控制在 80 行以内(不包括注释行),
当一个功能模块过大时往往造成阅读困难,因此当使用子函数等将相应功能抽取出来,这也有利
于提高代码的重用度。
单个类也不宜过大,当出现此类情况时当将相应功能的代码重构到其他类中,通过组合等方
式来调用,建议单个类的长度包括注释行不超过 1500 行。
尽量避免使用大类和长方法。
2.4 行宽
页宽应该设置为 80 字符。一般不要超过这个宽度 , 这会导致在某些机器中无法以一屏来完整
显示 , 但这一设置也可以灵活调整。在任何情况下 , 超长的语句应该在一个逗号后或一个操作符
前折行。一条语句折行后 , 应该比原来的语句再缩进一个 TAB 或 4 个空格,以便于阅读。
2.5 间隔
类、方法及功能块间等应以空行相隔,以增加可读性,但不得有无规则的大片空行。
操作符两端应当各空一个字符以增加可读性。
相应独立的功能模块之间可使用注释行间隔,并标明相应内容,具体参看附录的代码示例
2.6 对齐
关系密切的行应对齐,对齐包括类型、修饰、名称、参数等各部分对齐。
连续赋值时当对齐操作符。
共享
文档名称
Java 开发规范
版本
文档编号 日期
2010-11-25
第 7 页/共 7 页
文档名称
Java 开发规范
版本
文档编号 日期
2010-11-25
当方法参数过多时当在每个参数后(逗号后)换行并对齐。
当控制或循环中的条件比较长时当换行(操作符前)、对齐并注释各条件。
变量定义最好通过添加空格形成对齐,同一类型的变量应放在一起。如下例所示:
Table2.对齐示例
//变量对齐 -----------------------------------------------
int count = 100;
int length = 0;
String strUserName = null;
Integer[] porductCode = new Integer(2); //产品编码数组
//参数对齐 ----------------------------------------------
public Connection getConnection(String url,
String userName,
String password)
throws SQLException,IOException{
}
//换行对齐 ----------------------------------------------
public final static String SQL_SELECT_PRODUCT = “SELECT * “
+ “ FROM TProduct WHERE Prod_ID = ”
+ prodID;
//条件对齐 ----------------------------------------------
if( Condition1
&& Condition2
//当条件一
//并且条件二
|| Condition3){ //或者条件三
}
for(int i = 0;
i < productCount.length; //循环终止条件
i++){
}
2.7 括号
{} 中的语句应该单独作为一行,左括号 "{" 当紧跟其语句后,右括号 "}" 永远单独作为一行且
与其匹配行对齐,并尽量在其后说明其匹配的功能模块。
较长的方法以及类、接口等的右括号后应使用 //end ... 等标识其结束。如 :
类的结束符: } //EOC ClassName ,
方法结束符: } //end methodName() ,
功能块结束: } //end if...userName is null?
循环快结束: } //end for...every user in userList
不要在程序中出现不必要的括号,但有时为了增加可读性和便于理解,当用括号限定相应
项。
左括号是否换行等随个人习惯而定,若换行则当与其前导语句首字符对齐。
共享
第 8 页/共 8 页
剩余29页未读,继续阅读
资源评论
lzx13599381087
- 粉丝: 2
- 资源: 9万+
下载权益
C知道特权
VIP文章
课程特权
开通VIP
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功