java系统开发规范

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

1、JA/A开发规范编写人：彭毅批准人：批准日期：版本历史修改口期版本作者/修改人修改内容评审号变更控制号2014-09-20V1.0彭毅创建无无目录1前言41.1文档目的41.2适用范围41.3名词解释41.4参考资料42Java开发规范42.1排版规范52.1.1缩进52.1.2分界符（如人括号’{'和'}'）52.1.3空格62.1.3.1加空格的情况62.1.3.2不加空格的情况62.2注禅规范72.3命名规范72.3.1包名72.3.2类名和接口72.3.3方法名72.3.4属性名82.3.5变量82.3.6常量82.4编码规范82.4.1明确方法功能82.4.2明确类功能9

2、2.4.3三层调用顺序91.1文档目的代码规范对程序员很重要的一些原因：一、一个软件得花费其生命周期的80%去维护。二、几乎没冇任何软件在整个生命周期中是由其原作者维护的。三、代码规范提高了软件的可读性，能够让工程师更快、更透彻的了解新的代码。1.2适用范围本规范规定了使用Java语言编程时排版、注释、命名、编码的规则。本规范适川于使川Java语言编程的产品和项冃1.3名词解释术语解释规则编程时强制必须遵守的原则格式：対此规范格式的说明。说明：対此规范或建议进行必要的解释。示例：对此规范或建议从正、反两个方面给出例子。1.4参考资料编号资料名称作者2Java开发规范FI志记录规范规

3、范H志设计规范主要目的是节省工作量，帮助对问题进行诊断。最终终端用户可以获得更好的应用程序，并能从技术支持团队获得迅速的响应。2.1排版规范2.1.1缩进程序块要采用缩进风格编写，缩进一个tab键。示例：以下例子不符合规范publicvoidadd(intadd,intaddend){returnadd+addend;应该如下书写publicvoidadd(intadd,intaddend){returnadd+addend;2.1.2分界符(如大括号“r和(y)根据我们的编码习惯，左人括号“{”位于声明语句同行的末尾，右人括号“}”另起一行，与相应的声明语句对齐，除非是一•个空语

4、句，“}”应紧跟在“{”之后。在函数体的开始、类和接口的定义、以及if、for、do>while>switch、case语句中的程序都要釆用如上的缩进方式，空构造函数除外。示例：以下例子不符合规范for(...)...//programcodeif(...)...//programcode}voidexample_fun(void)...//programcode}publicXX(){}〃空构造函数应该如下书写for(...){...//programcode}if(...){...//programcode}voidexample_fun(void){...//programc

5、ode}publicXX(){}2.1.3空格在两个以上的关键字、变量、常量进行对•等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如・），后不应加空格。2.1.3.1加空格的情况一、逗号、分号只在后面加空格。inta,b,c;二、比较操作符,赋值操作符7、算术操作符“+”、”％”，逻辑操作符”&&”、“&”,位域操作符•，AH等双目操作符的前后加空格。if(current_time>=MAX_TIME_VALUE)a=b+c;a*=2;a=bA2;三、if、for、while,switch等与后面的括号间应加空格,使if等关键字

6、更为突出、明显。if（a>=b&&c>d）2.1.3.2不加空格的情况一、屮、”〜”、（地址运算符）等单冃操作符前后不加空格。flag=lisEmpty;//非操作T与内容之间i++;//”++”,”」与内容之间二、T前后不加空格。p.id=pid;〃叮前后不加空格2.2注释规范日前暂时不定，尽最使用类名、变最名和方法名代码注释。如保存用户方法，如果我们命名成saveUser,那么一看就知道这个方法是保存用户。2.3命名规范2.3.1包名包名采用域后缀倒置的加上自定义的包名，采川小写字母。在项冃内部应该规划好包名的范围，防止产生冲突。产品线的产品使用产品的名称加上模块的名称。格式：

7、crushengyuan•项H名称（产品）•模块名称•了模块名称示例:应该如F书写通丿IJdao模块包名：cn.shengyuan.ebp.core.dao;通用util模块包名：cn.shengyuari.ebp.core.util;2.3.2类名和接口类名和接口使用意义完整的英文和数字描述，何:个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。类名是一个名词，尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词（除非该缩写词被广泛的使用，如URL,HT