关闭

关闭

关闭

封号提示

内容

首页 J2EE项目工程代码编写规范.doc

J2EE项目工程代码编写规范.doc

J2EE项目工程代码编写规范.doc

上传者: 1254 2011-10-10 评分 0 0 0 0 0 0 暂无简介 简介 举报

简介:本文档为《J2EE项目工程代码编写规范doc》,可适用于IT/计算机领域,主题内容包含JEE项目工程代码编写规范代码编写规范目的:能够在编码过程中实现规范化为以后的程序开发中养成良好的行为习惯。代码编写规范使用范围:JEE项目开发。包符等。

JEE项目工程代码编写规范代码编写规范目的:能够在编码过程中实现规范化为以后的程序开发中养成良好的行为习惯。代码编写规范使用范围:JEE项目开发。包命名规范:目的:包的命名规范应当体现出项目资源良好的划分servlet类所在包命名规范:公司名称开发组名称项目名称webservlet例如:netlinkcnwebservlet自定义标签类所在包命名规范:公司名称开发组名称项目名称webtags例如:netlinkcnwebtags过滤器类所在包命名规范:公司名称开发组名称项目名称webfilter例如:netlinkcnwebfilterAction类所在包命名规范:公司名称开发组名称项目名称webstrutsaction例如:netlinkcnwebstrutsactionActionForm类所在包命名规范:公司名称开发组名称项目名称webstrutsform例如:netlinkcnwebstrutsformJavabean所在包命名规范:公司名称开发组名称项目名称webstrutsserviceimpl例如:netlinkcnwebserviceimplJavabean实现接口命名规范:公司名称开发组名称项目名称webservice例如:netlinkcnwebserviceDAO类所在包命名规范:公司名称开发组名称项目名称daoimpl例如:netlinkcndaoimplDAO类所实现的接口在包中命名规范:公司名称开发组名称项目名称dao例如:netlinkcndaoPOJO类与hbm文件所在包命名规范:公司名称开发组名称项目名称daohbm例如:netlinkcndaohbm全局公共类、接口类所在包命名规范:公司名称开发组名称项目名称global例如:netlinkcnglobal全局工具类所在包命名规范:公司名称开发组名称项目名称util例如:netlinkcnutil类命名规范基本命名规范:类、接口命名命名规范:以大写字母开头如果有多个单词每个单词头字母大写例如:StudentInfo接口命名命名规范:以大写字母"I"开头如果有多个单词每个单词头字母大写例如:IStudentInfo接口实现类命名:命名规范:将实现的接口名称的首字母"I"去掉以"Impl作为结尾"如果有多个单词每个单词头字母大写。例如:StudentInfoImplJEESSH框架命名规范servlet类命名:命名规范:以Servlet单词结尾例如:LoginServletPOJO命名:使用hibernate自动生成的类即可DAO类命名:使用hibernate自动生成的类即可Action类命名:命名规范:Action的命名以POJO名称来制定POJO名称Action例如:一个POJO名称为Diary其对应的action为DiaryActionActionForm类命名:命名规范:ActionForm的命名以POJO名称来制定POJO名称Form例如:一个POJO名称为Diary其对应的actioForm为DiaryForm业务逻辑接口命名:命名规范:业务逻辑接口的命名以POJO名称来制定IPOJO名称Service例如:一个POJO名称为Diary其对应的业务逻辑接口为IDiaryService业务逻辑实现类命名:命名规范:业务逻辑接口实现类的命名以POJO名称来制定例如:一个POJO名称为Diary对应的业务逻辑接口实现类名为DiaryServiceImpl类变量命名:命名规范:变量名首字母必须小写如果该变量名有多个单词组成后面的单词首字母大写单词与单词之间不要使用""做连接变量名访问控制必须为私有可以对其增加setter与getter方法。例如:privateintstudentAge publicintgetStudentAge() {returnstudentAge } publicvoidsetStudentAge(intstudentAge) {thisstudentAge=studentAge }常量命名:命名规范:所有字母大写如果有多个单词组成单词与单词之间以”“隔开。而且该变量必须是公共、静态、final类型例如:publicstaticfinalStringUSERNAME=”userName“方法命名命名规范:首字母必须小写如果该变量名有多个单词组成后面的单词首字母大写单词与单词之间不要使用""做连接。单词不要使用名词。例如:publicintcheckLogin(Stringname,Stringpwd){}注释规范:注释规范是整个开发规范中最为重要的组成部分必须严格执行。类的注释:作用:注释整个类简单概述该类作用。书写规范:类的注释必须写在该类的声明语法之前。在注释中要描述该类的基本作用作者日期版本公司名称版权声明。格式: ** *类功能描述:(大致描述类的功能) *author:编写者名称* *version:类文件的版本号从开始(自己确定版本号的增改 *情况)修改情况(修改时间、作者、改动情况)**see包名参考类名(列出父类引入类每个类占一行)如果有*可省略 *相关数据如:(便于理解本类的一些常量数据及某些数据的格式 *或认为比较重要的数据如果没有可省略) * 类的声明语法例如:** *<p>Title:管理员模块数据处理类<p> *<p>Description:两个数相加<p>*<p>Copyright:Copyright(c)<p>*<p>Company:华腾软件公司<p>* *author童金虎* *version$Revision:$$Date:$ *publicclassAdminDAO变量、常量注释:作用:简单描述该变量的意义。书写规范:变量注释必须写在变量定义之前简单描述其代表的意义。格式:**  *变量功能描述:(大致描述变量的功能) *例如: ** *定义年龄变量 *publicintage方法注释:作用:对该方法功能简单描述其参数、返回值意义的注解。书写规范:方法注释必须写在方法定义之前。该注释包括:方法其功能的简单描述方法的参数、返回值类型、返回值意义简单的描述。格式: **  *方法功能说明  *paramargs(参数类型可以写在参数后也可以省  *略。每个参数占一行)  *return输出参数(多种情况写在同一行)  *see类#参考方法(与此方法有调用关系的方法供参  *考不必每个方法都完整列出要选择有意义的每个  *方法占一行)  *exception异常处理类(方法中能够引发的异常每  *个异常占一行) * 例如:** *修改管理员密码 *paramadminId管理员编号 *paramoldPassword旧密码 *parampassword新密码*returnboolean是否编辑成功 *throwsUserException *throwsServiceException *publicbooleaneditAdminPassword(intadminId,StringoldPassword,Stringpassword)throwsUserException,ServiceExceptionJsp页面命名:命名规范:jsp页面名称要以小写字母开头如果有多个单词组成后面的单词以大写字母开头。名称要体现出该页面的意义最好能够与模块名称联系在一起。例如:loginjsp登录页面registerjsp注册页面messagejsp客户留言页面JEE项目工程文件夹组织规范:目的:规范学员web应用程序的资源组织形式形成良好的文件组织习惯。文件的组织形式应当体现模块的划分。根据eclipse工具的特征项目的目录结构为:src 存放java文件 WebRoot|images存放web程序所需的公共图片|css存放web程序所需的公共样式表|js存放web程序所需的公共js文件|commons存放web程序所需的公共文件|功能模块文件夹(存放与某个功能模块相关的资源)|images存放与该功能模块相关的图片|css存放与该模块相关的样式表文件|js存放与该模块相关的js文件|jsp、html页面|WEBINF|classes|lib|tld文件JEE项目提交规范项目完成时要将项目作为一个产品交付用户良好的项目组织规范可以使用户可以方便的找寻项目中需要的资源同时也是一个公司专业性的体现。项目提交时要按照下列文件格式进行提交。项目主文件夹:作用:存放项目其他资源文件。命名规范:时间班级编号第X小组。例如:GST第四小组。项目主文件夹下面包括以下文件夹和文件:|src:保存java文件。|database:保存数据库的脚本文件或者数据库备份文件。|source:保存eclipse工程中WebRoot目录下的所有文件。|depend:保存编译该程序必须依赖的其他jar文件。|javadoc:保存所有类生成的javadocapi文档。|war:保存程序的归档文件|xxwar:已经打包好的工程文件可以直接运行。|project:保存开发项目原工程代码及文件。|产品说明书doc:图文方式展现该产品使用方法。|buildxml:ant脚本用于生成运行的war文件。|项目解说ppt:进行项目讲解的ppt(ppt仅供在校模拟项目使用不用于其他商业用途)注:一个完整的项目中数据库必须有一定量的有效的测试数据来支持该程序的运行 

热点搜索换一换

用户评论(0)

0/200

精彩专题

上传我的资料

每篇奖励 +2积分

资料评价:

/6
0下载券 下载 加入VIP, 送下载券

意见
反馈

立即扫码关注

爱问共享资料微信公众号

返回
顶部