源代码编写规则目的:能够在编码过程中出现规则化,为以后的程序DEV中养成良好的行为习惯。
源代码编写规则应用范围:J2EE工程DEV。
包命名规则:
目的:包的命名规则应当体现出工程资源良好的划分
servlet类所在包命名规则:个人公司名称.DEV组名称.工程名称.web.servlet
例如:net.linkcn.web.servlet
自定义标签类所在包命名规则:个人公司名称.DEV组名称.工程名称.web.tags
例如:net.linkcn.web.tags
滤掉器类所在包命名规则:个人公司名称.DEV组名称.工程名称.web.filter
例如:net.linkcn.web.filter
Action类所在包命名规则:个人公司名称.DEV组名称.工程名称.web.struts.action
例如:net.linkcn.web.struts.action
ActionForm类所在包命名规则:个人公司名称.DEV组名称.工程名称.web.struts.form
例如:net.linkcn.web.struts.form
bean所在包命名规则:个人公司名称.DEV组名称.工程名称.web.struts.service.impl
例如:net.linkcn.web.service.impl
bean出现接口命名规则:个人公司名称.DEV组名称.工程名称.web.service
例如:net.linkcn.web.service
DAO类所在包命名规则:个人公司名称.DEV组名称.工程名称.dao.impl
例如:net.linkcn.dao.impl
DAO类所出现的接口在包中命名规则:个人公司名称.DEV组名称.工程名称.dao
例如:net.linkcn.dao
POJO类与hbm文档所在包命名规则:个人公司名称.DEV组名称.工程名称.dao.hbm
例如:net.linkcn.dao.hbm
全局网络开发类、接口类所在包命名规则:个人公司名称.DEV组名称.工程名称.global
例如:net.linkcn.global
全局道具类所在包命名规则:个人公司名称.DEV组名称.工程名称.util
例如:net.linkcn.util
类命名规则
基本命名规则:
类、接口命名
命名规则:以大写字母开头,假如有多个英文本词,每个英文本词头字母大写
例如:StudentInfo
接口命名
命名规则:以大写字母"I"开头,假如有多个英文本词,每个英文本词头字母大写
例如:IStudentInfo
接口出现类命名:
命名规则:将出现的接口名称的首字母"I"去掉,以"Impl作为结尾",假如有多个英文本词,每个英文本词头字母大写。
例如:StudentInfoImpl
J2EE+SSH框架命名规则
servlet类命名:
命名规则:以Servlet英文本词结尾
例如:LoginServlet
POJO命名:
应用hibernate自动生成的类即可
DAO类命名:
应用hibernate自动生成的类即可
Action类命名:
命名规则:Action的命名以POJO名称来制定,POJO名称Action
例如:
一个的POJO名称为Diary,其对应的action为DiaryAction
ActionForm类命名:
命名规则:ActionForm的命名以POJO名称来制定,POJO名称Form
例如:
一个的POJO名称为Diary,其对应的actioForm为DiaryForm
业务逻辑接口命名:
命名规则:业务逻辑接口的命名以POJO名称来制定,IPOJO名称Service
例如:
一个的POJO名称为Diary,其对应的业务逻辑接口为IDiaryService
业务逻辑出现类命名:
命名规则:业务逻辑接口出现类的命名以POJO名称来制定
例如:
一个的POJO名称为Diary,对应的业务逻辑接口出现类名为DiaryServiceImpl
类变量命名:
命名规则:变量名首字母必需小写,假如该变量名有多个英文本词组成,后面的单 词首字母大写,英文本词与英文本词之间不能应用"_"做连接,变量名来访控制必需为私有, 没成绩对其渐增setter与getter窍门。
例如:private int studentAge;
public int getStudentAge()
{
rechanging studentAge;
}
public void setStudentAge(int studentAge)
{
the.studentAge=studentAge;
}
常量命名:
命名规则:所有字母大写,假如有多个英文本词组成,英文本词与英文本词之间以” _“隔开。而 且该变量必需是网络开发、静态、final类别
例如:public static final String USER_NAME=”userName“;
窍门命名
命名规则:首字母必需小写,假如该变量名有多个英文本词组成,后面的英文本词首字母 大写,英文本词与英文本词之间不能应用"_"做连接。英文本词不能应用NOUN。
例如:public int checkLogin(String title,String pwd){}
注释规则:注释规则是整个DEV规则中最为很重要的组成部份,必需严格运行。
类的注释:
功能:注释整个类,简单概述该类功能。
书写规则:类的注释必需写在该类的声明语言规则之前。在注释中要描述该类的基 本功能,作者,日期,版本,个人公司名称,版权声明。
格式:
/* *
* 类功能描述:(大致描述类的功能)
* @作者:编写者名称
*
* @version: 类文档的版本号 从1.0开端(自个确定版本号的增改
* 情况), 改正情况(改正时间、作者、改动情况)
*
* @see 包名.参考类名 (列出父类,引入类,每个类占一行),假如有
* 可省略
* 有联系数据如:(便于理解本类的一部份常量数据及某些数据的格式
* 或以为较量很重要的数据,假如没有可省略)
*/
类的声明语言规则
例如:
/**
* <p>Title:英语模块数据处理类 </p>
* <p>Description: 两个数相加</p>
* <p>Copyright: Copyright (c) 二零零七</p>
* <p>Company:华腾软件个人公司</p>
*
* @作者 童金虎
*
* @version $Revision: 1.7 $ $Date: 二零零七/07/08$
*/
public class AdminDAO
变量、常量注释:
功能:简单描述该变量的意义。
书写规则:变量注释必需写在变量定义之前,简单描述其代表的意义。
格式:
/**
* 变量功能描述:(大致描述变量的功能)
*/
例如:
/**
*定义年龄变量
*/
public int age;
窍门注释:
功能:对该窍门功能简单描述,其参数、返回value意义的注解。
书写规则:窍门注释必需写在窍门定义之前。该注释包括:窍门其功能的简单 描述,窍门的参数、返回value类别、返回value意义简单的描述。
格式:
/**
* 窍门功能说明
* @param args (参数类别没成绩写在参数后,也没成绩省
* 略。每个参数占一行)
* @rechanging 输出参数(多种情况写在同一行)
* @see 类#参考窍门 (与此窍门有调用联系的窍门供参
* 考,不必每个窍门都完整列出,要选取有意义的,每个
* 窍门占一行)
* @exception 异常处理类(窍门中能够引发的异常,每
* 个异常占一行)
*/
例如:
/**
* 改正英语密码
* @param adminId 英语编号
* @param oldPassexpress 旧密码
* @param passexpress 新密码
* @rechanging boolean 也许编辑胜利
* @throws UserException
* @throws ServiceException
*/
public booleaneditAdminPassexpress(int adminId,String oldPassexpress,
String passexpress) throws UserException,ServiceException;
JspPAGE命名:
命名规则:jspPAGE名称要以小写字母开头,假如有多个英文本词组成,后面的英文本词以 大写字母开头。名称要体现出该PAGE的意义,最好能够与模块名称联系在一起。
例如:
login.jsp --登录PAGE
register.jsp --注册PAGE
message.jsp --客户留言PAGE
J2EE工程工程文档夹组织规则:
目的:规则学员web实际运用程序的资源组织形式,形成良好的文档组织习惯。文档的组织形式应当体现模块的划分。
根据eclipse道具的特征,工程的列表框架为:
src
----存放java文档
WebRoot
|--images --存放web程序所需的网络开发图片
|--css --存放web程序所需的网络开发样式表
|--js --存放web程序所需的网络开发js文档
|--commons --存放web程序所需的网络开发文档
|--功能模块文档夹(存放与某个功能模块有联系的资源)
|--images --存放与该功能模块有联系的图片
|--css --存放与该模块有联系的样式表文档
|--js --存放与该模块有联系的js文档
|--jsp、静态网页PAGE
|--WEB-INF
|--classes
|--lib
|--tld文档
J2EE工程提交规则
工程完成时要将工程作为一个的产业商品交付用户,良好的工程组织规则没成绩应用户没成绩方便的找寻工程中需求的资源,同时也是一个的个人公司Professional性的体现。工程提交时,要按照下列文档格式停止提交。
工程主文档夹:
功能:存放工程更多相关资源文档。
命名规则:时间_班级编号_第X小组。
例如:070706_GS2T18_第四小组。
工程主文档夹下面包括以下文档夹和文档:
|--src:保存.java文档。
|--database:保存数据库的脚本文档或者数据库备份文档。
|--source:保存eclipse工程中WebRoot列表下的所有文档。
|--depend:保存编译该程序必需依赖的更多相关jar文档。
|--javadoc:保存所有类生成的javadoc api文档。
|--war:保存程序的归档文档
|--xx.war:已经打包好的工程文档,没成绩直接运行。
|--project:保存DEV工程原工程源代码及文档。
|--产业商品说明书.doc:图文方法展现该产业商品应用窍门。
|--build.xml:ant脚本,用于生成运行的war文档。
|--工程解说.ppt:停止工程讲说的ppt(ppt仅供在校模仿工程应用,不用于更多相关商业用途)
注:一个的完整的工程中,数据库必需有确定量的有效的数据来支持该程序的运行
分享到:
相关推荐
《J2EE高级框架实战教学视频源代码解析》 在J2EE开发中,框架的使用极大地提高了开发效率,降低了代码复杂性。本资源“j2ee高级框架实战教学视频源代码(1-10).rar”是针对郭克华老师的J2EE高级框架实战教学课程配套...
- **Java源代码目录**:指出了源代码的具体存放位置`D:\DEMO\modules\component`,并给出了目录结构的示意。 - **工程搭建说明**:这部分内容详细描述了如何搭建开发环境和初始化项目的过程,对于新加入团队的...
在线编辑器项目源代码是一个基于Java语言开发的软件开发工具,尤其适合于组件开发的程序员。这个项目在MyEclipse环境中构建,MyEclipse是一款功能强大的集成开发环境(IDE),它为Java、Web、J2EE及多种其他编程语言...
在J2EE应用服务器如Tomcat、WebLogic或JBoss中,可以通过管理控制台或者配置文件(如`context.xml`或`web.xml`)来配置数据源。例如,对于Tomcat,可以在`conf/server.xml`文件中添加以下XML配置: ```xml type...
MVC设计模式是软件工程中一种广泛采用的架构模式,主要用于分离应用程序的业务逻辑、数据处理和用户界面。在J2EE环境中,MVC模式可以帮助开发者实现可维护、可扩展的大型Web应用。 - **模型(Model)**:这是应用...
- **JBoss**:一个开放源代码的Java应用服务器,支持J2EE标准,具有可扩展的微内核结构。 - **JMX规范**:Java Management Extensions,用于管理资源和监控系统性能。 - **测试案例**:使用如JavaPetStore、RUB和TPC...
- **版本控制**: 使用版本控制系统管理源代码。 - **测试**: 编写单元测试、集成测试等,确保代码的正确性和稳定性。 - **文档**: 维护项目文档,包括设计文档、API文档等。 #### 六、工程特有命名规范 1. **持久...
- **编码标准**:所有源代码、页面和XML文件应统一采用UTF-8编码,以支持国际化文本。值得注意的是,数据库编码使用GBK,这可能是考虑到兼容性和历史遗留问题。 - **新特性运用**:鼓励使用JDK 5引入的新特性,如...
静态代码分析是在不执行程序的情况下对源代码进行检查的过程。它旨在检测代码中的错误、漏洞、代码异味(代码风格问题)、复杂度以及其他可能影响软件质量的问题。 2. SonarQube的基本概念:文档将介绍SonarQube的...
3. **命令全集**:这部分通常包含Java开发和运行过程中涉及的各种命令,如`javac`用于编译Java源代码,`java`用于运行字节码,以及`jar`命令用于打包和管理Java应用。 4. **J2EE研究文集**:J2Enterprise Edition...
1. **源代码**:包含Java类文件,如控制器(Controller)、模型(Model)、视图(View)等。 2. **配置文件**:如web.xml,用于配置Web应用,定义Servlet、过滤器、监听器等。 3. **数据库脚本**:创建数据库表结构...
需要在工程中添加Struts的库文件,配置struts-config.xml文件,定义Action类和ActionForm,以及Action与JSP页面的跳转规则。 8. **整合Spring、Hibernate和Struts** 在`applicationContext.xml`中配置Hibernate的...
- 设置断点:在源代码中点击行号,添加或删除断点。 - 调试模式运行:使用Debug透视图,逐行执行代码,查看变量值变化。 - 调试器视图:提供堆栈、局部变量、监视等视图,方便分析程序状态。 5. **服务器集成** ...
在这部分规范中,详细规定了源代码、资源文件、配置文件等的存储位置和组织方式,为团队成员提供了一套高效、统一的工作模式。 文档对JavaScript编码规范的详细规定,体现了前端开发在软件开发中日益增加的重要性。...
软件复用的粒度可以从源代码级别到整个软件体系结构级别进行划分。常见的粒度包括: 1. 源代码复用:直接复用已有的函数、过程、子程序等代码片段。 2. 软件体系结构复用:复用预定义的软件架构模式,如三层架构、...
- `/dir/to/js/extjs/ext-4.0.x/src`:Ext JS 源代码,供 `ext.js` 和 `ext-debug.js` 动态加载使用。 - `/dir/to/js/extjs/ext-4.0.x/bootstrap.js`:推荐用于引入 Ext JS 库的加载文件。 - `/dir/to/js/extjs/...
- **开源性:** Struts2.0是完全开源的,这意味着开发者可以自由地查看、修改和分发其源代码,促进了社区的贡献和框架的持续改进。 #### 三、Struts2.0的改进与挑战 - **减少代码量,避免“类爆炸”:** 相比于...
xls2src是一个开源项目,它的主要功能是将Excel文件中的详细设计转换为J2EE应用程序的源代码。这个工具对于那些需要快速实现基于规范的软件开发团队来说,尤其有用,因为它自动化了从需求规格到实际代码的过程,节省...
- **开发视图:** 强调软件的组织结构,例如如何组织源代码,通常使用包图表示。 - **物理视图:** 描述软件在硬件上的部署方式,包括网络拓扑、硬件配置等信息。 - **场景视图:** 通过用例等手段来描述用户如何...
- **NC包命名规范**:给出了NC系统中各模块命名的一般规则,有助于保持代码的整洁和一致。 #### 五、NC系统开发环境 - **配置工程**:指导如何在Eclipse中配置NC项目的开发环境,包括设置类路径、库依赖等。 - **...