欢迎来到天天文库
浏览记录
ID:11733560
大小:238.35 KB
页数:39页
时间:2018-07-13
《css_金审工程应用软件java开发规范_文档编号:应用开发java编码 》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、应用开发Java编码规范文档编号:应用开发Java编码规范(版本v1.0.0)2021年6月25日第33页应用开发Java编码规范成文信息主题词:java开发编码规范作者:文档类别:开发规范审核:批准:文档性质:正式稿主送:存档日期:抄送:发布日期:变更信息版本原因作者日期第33页应用开发Java编码规范目录目录1第一章概述11.1编写目的11.2定义11.3参考资料1第二章代码格式与风格22.1基本原则22.2缩进22.3长度22.4行宽32.5间隔32.6括号3第三章注释43.1基本原则43.2JavaDoc43.3文件注释43.4类、
2、接口注释53.5方法注释53.6其他注释63.7注释参考表6第四章命名规范84.1基本原则84.2文件、包94.3类、接口94.4字段94.4.1常量94.4.2变量和参数94.4.3组件/部件10第33页应用开发Java编码规范4.4.4集合104.4.5神秘的数104.4.6其他104.5方法114.6异常114.7命名约定表11第五章声明135.1基本原则135.1.1包135.1.2类、接口145.1.3方法145.1.4字段155.1.5示例16第六章类与接口176.1基本原则176.2抽象类与接口186.3继承与组合186.4构
3、造函数和静态工厂方法186.5toString(),equals(),hashCode()...196.6SingletonClass20第七章方法217.1基本原则217.2参数和返回值21第八章表达式与语句228.1基本原则228.2控制语句228.3循环语句24第九章错误与异常249.1基本原则249.2已检查异常与运行时异常259.3异常的捕捉与处理25第十章性能与安全26第33页应用开发Java编码规范10.1基本原则2610.2String与StringBugffer2610.3集合2710.4对象2710.5同步2710.6f
4、inal2710.7垃圾收集和资源释放28第十一章附录2911.1HTML/JSP格式建议2911.1.1文件头2911.1.2缩进29第33页应用开发Java编码规范第33页应用开发Java编码规范第33页应用开发Java编码规范第一章概述1.1编写目的开发规范制定的目的是为了保证在系统设计、编码、测试、维护的过程中项目组人员遵循一套统一系统设计标准、应用程序编写标准、页面风格标准,借以提高软件开发团队的效率、增加代码的统一性、可读性,可维护性,保障项目开发稳定。本文档的阅读对象为开发人员。本文档提供了项目开发的各项规范以及指导原则。开发
5、人员在开发过程中必须严格遵守此开发规范。1.2定义基类:应用程序最底层的程序支撑,封装应用程序的基本功能和框架实现。本文中凡是规范标题下的内容,都是开发过程中必须遵守的约定。本文中凡是注意事项标题下的内容,都是开发过程中最好遵守的原则,它们多是一些技巧的提示,可提高应用程序的性能,避免不必要的错误。1.3参考资料想要更深入了解本文档涉及到背景知识,可访问以下网站。SUN的官方网站:http://java.sun.comIBM官方网站:http://www-900.ibm.com/developerWorks关于代码规范标准可参阅:lJava
6、ProgrammingStyleGuidehttp://www.javaranch.com/style.jsplAmbySoftInc.CodingStandardsforJavav17.01dhttp://www.ambysoft.com/javaCodingStandards.htmllCodeConventionsfortheJavaTMProgrammingLanguagehttp://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.htmll《EffivtiveJava》第33页应用
7、开发Java编码规范l《ThinkinginJava》第一章代码格式与风格1.1基本原则代码格式与风格的基本原则是:便于开发,易于交流,前后一致,符合本规范求,形成全公司统一风格。1.2缩进子功能块当在其父功能块后缩进。当功能块过多而导致缩进过深时当将子功能块提取出来做为子函数。代码中以TAB(4个字符)缩进,在编辑器中请将TAB设置为以空格替代,否则在不同编辑器或设置下会导致TAB长度不等而影响整个程序代码的格式。例如:Table1.缩进示例publicvoidmethodName(){if(somecondition){for(…){/
8、/somesentences}//endfor}//endif}1.3长度为便于阅读和理解,单个函数的有效代码长度当尽量控制在100行以内(不包括注释行),当一个功能模块过大时往
此文档下载收益归作者所有