JAVA编程规范与开发指导

《JAVA编程规范与开发指导》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、JAVA编码规范与指导文件编号:制定单位^文件信息文件标题JAVA编码规范与指导起草部门公司架构组颁布H期2009-12-13所属制度体系上位文件修订记录文档修订记录说明:每一•条修订记录必须细化到每一个小节修改。日期版本修订说明编写者审核2009-12-161.1修改内容结构曹思彬架构委员会1前言41.1编写目的41・2预期读者41.3内容52程序格式规范52.1Java文件组织格式52.2Java代码编写格式102.3Java注释格式133命名规范183.1包、类、文件方法及组件的命名193.1.1包的命名

2、193.1.2类、接口的命名193.1.3文件的命名193.1.4方法的命名203.1.5组件的命名203.2静态常量、变量、参数及异常的命名213.3对象的命名214编程指导234.1编程原则234.1.1类、接口234.1.2方法234.1.3变量234.1.4表达式与语句244.1.5异常捕捉244.1.6其它244.2日志254.3安全性264.4性能265质量评审标准275.1评审目标275.2扣分标准276代码范例276.1Java代码277附录281.1有效地使用这些标准281.2词汇表281前言

3、1.1编写目的本文试图提供一套编写高效可靠的Java代码的标准、约定和指导。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强。通过遵循和改进这些程序设计标准，使各项日产生的代码有更好的一致性，并提高软件开发团队的生产效率。本规范适用于釆用J2EE规范的项目中,所有项目中的Java代码（含JSP,SERVLET,JAVABEAN,EJB,开发工具生成的代码框架等）均应遵守这个规范。同时，也可作为其它项目的参考。要求相关项目都要遵循，并作为项目评审与验收依据。规范原则：＞遵循业界标准＞可读性强，意义清

4、楚＞整洁严谨、风格统一1.2预期读者本书的预期读者包括：技术管理人员、系统设计人员、系统开发人员、系统测试人员、系统维护人员及其他相关人员。系统开发人员要求已具有Java编程基础。读者类型章节导读系统设计人员系统开发人员系统维护人员技术管理人员系统测试人员质量控制人员其他1.3内容木规范与指导的内容主要有:＞结构和文档规范书写利标记注释的标准方式。＞命名规范命名定义（类名、方法名、变量名等等）的标准方式。＞编程指导描述一些重要的编码规则，可用于纠正以前设计的代码中存在的问题（或不建议使用的方法）和指导新程序的开

5、发，以提高代码的质屋。木文第6章节所描述的代码范例是具体规范的示例，请读者参考。程序格式规范2.1Java文件组织格式＞Java（*.java）文件组织格式依序包括修订说明、包和导入、类和接口、类的成员等部份。＞应把每个Java类放在单独的文件中（除内部类），但对于non-public的类来说，应该包含一个main（）方法，因为它们不能在它们的上下文范围之外被调用。2.1.1修订说明＞文件开头必须说明文件名、标识信息和版权信息。＞一个包含作者、日期和修改摘要的修订记录列表说明。＞如果文件由多个Class组成，列

6、出每个类的简要描述。＞如果文件是一个包的重要切入点，还要简要说明包的结构的基本原理。示例：类注释结构/**SCurrentFile*版权声明GIT版权所有*关联资源*修订记录：］）更改者:$Author时间：2009-12-04描述：创建*/2.1.2包和导入先package的名字，import列表紧跟在包的名字后边。package与import列表Z间用空行隔开。为每个口身独立的项目和一组有关联的方法创建一个新的java包。为了使package的命名和java包的规范一致，采用目录命名规范。import语句必

7、须遵循以下导入顺序：jdk标准包java扩展包使用外部库的包使用公司的公共包使用项目的公共包使用其它模块的包>import语句尽量不使用通配符（会加大程序编译时的开销和生成的类文件的大小）。示例：packagecom.git.common,display;importjava.io.File;importjava.util.List;importjava.lang,reflect.Proxy;2.1.3类和接口>类、接口定义之前应先进行注释。注释包括类、接口的目的、作用、功能、继承的父类，实现的接口、实现的算法

8、、使用方法、示例程序等，还可以包括期望改进T作的地方和不希望改变的地方。示例：/***

9、