Java程序开发规范

《Java程序开发规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、Java编程规范注：本规范适用于北京工业大学教育部数字社区工程研究中心进行java开发，还待进一步完善。日期操作版本作者2009-4-3起草文件V1.0赵忠诚Java程序开发规范第1章绪论1.1目的:本规范目的是为了使本组织能以标准、规范、统一的编程风格进行Java代码的开发工作。提高程序的可读性、可修改性和可维护性，方便团队的交流。本规范参考了:<><<高质量C++编程>>1.2范围:本规范适用于教育部数字社区工程研究中心使用Java开发团队所有成员，进行

2、产品开发、维护以及升级等编程操作。1.3概要说明:在这里引用文献1来说明代码规范的重要性:Ø一个软件的生命周期中，有80%都在进行维护；Ø很难有软件在整个生命周期中，都是由原来的作者进行维护的；Ø编码规范提高了软件的可读性，并且帮助软件工程师更加快速彻底地理解新的代码；Ø要想把你的源代码作为产品来发布，就需要保证它像你创作的其他作品那样被很好地封装，并且清理干净了。针对我们学校环境来说，师兄师姐毕业，师弟师妹入学属于软件工程师的不断更新，如果我们没有统一的完成的编程规范，每个人按照自己的编程风格和编程方法进行程序开发，在毕业之后很少有人能读懂他的程序，

3、对于后期的维护来说是一件非常头疼的问题，所以我们非常有必要总结出一套适合我们自己的Java开发规范。1.1重要说明:本规范为内部共享资源，版权属于教育部数字工程研究中心，如果现在或者以后有好的建议可以直接在该文件中进行添加和修改。第2章代码整体组织和风格这里所说的代码的整体组织和风格是针对一个文件而言，一个文件应该是由被空行分隔开的代码块所组成，并且每个块被特定的注释标识出来。每个文件不应该超过2000行(包括注释说明)。2.1Java源文件Java源文件必须包含一下几个部分(按照从上到下的顺序说明)：版权说明、包和引用语句、类/接口描述以及版本信息、

4、类方法以及变量声明和实现。Ø版权信息，所有的源文件都应该由列出了类名，日期和版权信息的C-style的注释开始，采用如下格式作为版权信息:/***@{#}S.javaCreatedon2009-4-6**CopyRight(c)2009BJUT,BeiJing.*Allrightreserved.*/Ø包和引用语句,大多数Java源文件的第一个非注释代码行都是包定义语句,当让可以不写包定义语句，但是在这里强烈建议写上包定义语句(如果你采用eclipse等开发环境写不写就由不得你了，除非你在它自动生成之后将其删掉)，在之后就是引用语句，如果引用的话当然没

5、有引用语句。做如下规定：1)包信息和引用语句之间要与一个空行2)引用语句之间不在同一个包中的引用也要有一个空行例如：packageedu.bjut.bjwater.checkrules.action;importjava.text.NumberFormat;importjava.text.SimpleDateFormat;importjava.util.*;importjavax.servlet.http.HttpServletRequest;importjavax.servlet.http.HttpSession;importedu.bjut.bjw

6、ater.pub.*;Ø类/接口描述以及版本信息/***@Package:src.test*@Description:TODO(用一句话描述该文件做什么)*@author:yan*@date:2009-4-6*@version:V1.0**@version@date@author@modify*------------------------------------------------*修改之后版本修改日期修改者修改内容*/Ø变量声明，按照文献1中所说，在声明变量时，首先声明static变量然后再声明类成员变量，声明顺序为，首先是public的类变

7、量，然后是protected的,接下来是包级的（没有访问修饰符），最后是private的。例：/**something......*/publicstaticStringstr=“test”;…………………/***Setthecharactersetforthefile.*/privatestaticCharsetcharset=Charset.forName("ISO-8859-15");/**something......*/publicStringstr=“test”;/***Thecharacterbufferreference.*/priva

8、teCharBufferindexFile;变量声明同时也要添加相应注释，注释这个变量的功能，