首页 诗词 字典 板报 句子 名言 友答 励志 学校 网站地图
当前位置: 首页 > 计算机考试 > 认证考试 > JAVA认证 >

J2EE项目代码编写规范(2)

2009-01-12 
代码编写规范

    例如:
  /**
  * <p>Title:管理员模块数据处理类 </p>
  * <p>Description: 两个数相加</p>
  * <p>Copyright: Copyright (c) 2007</p>
  * <p>Company:华腾软件公司</p>
  *
  * @author 童金虎
  *
  * @version $Revision: 1.7 $ $Date: 2007/07/08$
  */
  public class AdminDAO
  变量、常量注释:
  作用:简单描述该变量的意义。
  书写规范:变量注释必须写在变量定义之前,简单描述其代表的意义。
  格式:
  /**
  * 变量功能描述:(大致描述变量的功能)
  */
  例如:
  /**
  *定义年龄变量
  */
  public int age;
  方法注释:
  作用:对该方法功能简单描述,其参数、返回值意义的注解。
  书写规范:方法注释必须写在方法定义之前。该注释包括:方法其功能的简单 描述,方法的参数、返回值类型、返回值意义简单的描述。
  格式:
  /**
  * 方法功能说明
  * @param args (参数类型可以写在参数后,也可以省
  * 略。每个参数占一行)
  * @return 输出参数(多种情况写在同一行)
  * @see 类#参考方法 (与此方法有调用关系的方法供参
  * 考,不必每个方法都完整列出,要选择有意义的,每个
  * 方法占一行)
  * @exception 异常处理类(方法中能够引发的异常,每
  * 个异常占一行)
  */
  例如:
  /**
  * 修改管理员密码
  * @param adminId 管理员编号
  * @param oldPassword 旧密码
  * @param password 新密码
  * @return boolean 是否编辑成功
  * @throws UserException
  * @throws ServiceException
  */
  public booleaneditAdminPassword(int adminId,String oldPassword,
  String password) throws UserException,ServiceException;
  Jsp页面命名:
  命名规范:jsp页面名称要以小写字母开头,如果有多个单词组成,后面的单词以 大写字母开头。名称要体现出该页面的意义,最好能够与模块名称联系在一起。
  例如:
  login.jsp --登录页面
  register.jsp --注册页面
  message.jsp --客户留言页面
  J2EE项目工程文件夹组织规范:
  目的:规范学员web应用程序的资源组织形式,形成良好的文件组织习惯。文件的组织形式应当体现模块的划分。
  根据eclipse工具的特征,项目的目录结构为:
  src
  ----存放java文件
  WebRoot
  |--images --存放web程序所需的公共图片
  |--css --存放web程序所需的公共样式表
  |--js --存放web程序所需的公共js文件
  |--commons --存放web程序所需的公共文件
  |--功能模块文件夹(存放与某个功能模块相关的资源)
  |--images --存放与该功能模块相关的图片
  |--css --存放与该模块相关的样式表文件
  |--js --存放与该模块相关的js文件
  |--jsp、html页面
  |--WEB-INF
  |--classes
  |--lib
  |--tld文件
  J2EE项目提交规范
  项目完成时要将项目作为一个产品交付用户,良好的项目组织规范可以使用户可以方便的找寻项目中需要的资源,同时也是一个公司专业性的体现。项目提交时,要按照下列文件格式进行提交。
  项目主文件夹:
  作用:存放项目其他资源文件。
  命名规范:时间_班级编号_第X小组。
  例如:070706_GS2T18_第四小组。
  项目主文件夹下面包括以下文件夹和文件:
  |--src:保存.java文件。
  |--database:保存数据库的脚本文件或者数据库备份文件。
  |--source:保存eclipse工程中WebRoot目录下的所有文件。
  |--depend:保存编译该程序必须依赖的其他jar文件。
  |--javadoc:保存所有类生成的javadoc api文档。
  |--war:保存程序的归档文件
  |--xx.war:已经打包好的工程文件,可以直接运行。
  |--project:保存开发项目原工程代码及文件。
  |--产品说明书.doc:图文方式展现该产品使用方法。
  |--build.xml:ant脚本,用于生成运行的war文件。
  |--项目解说.ppt:进行项目讲解的ppt(ppt仅供在校模拟项目使用,不用于其他商业用途)
  注:一个完整的项目中,数据库必须有一定量的有效的测试数据来支持该程序的运行

 

3COME考试频道为您精心整理,希望对您有所帮助,更多信息在http://www.reader8.com/exam/

热点排行