述: (大致描述变量的功能) */ 例如: /** *定义年龄变量 */ public int age; 方法注释: 作用:对该方法功能简单描述,其参数、返回值意义的注解。 书写规范:方法注释必须写在方法定义之前。该注释包括:方法其功能的简单 描述,方法
的参数、返回值类型、返回值意义简单的描述。 格式: /** * 方法功能说明 * @param args (参数类型可以写在参数后,也可以省 *
略。每个参数占一行) * @return 输出参数(多种情况写在同一行) * @see 类#参考方法 (与此方法有调用关系的方法供参 * 考,不必每个方法都完整列出,要选择有意义的,每个 * 方法占一行) * @exception 异常处理类(方法中能够引发的异常,每 * 个异常占一行) */ 例如: /** * 修改管理员密码 * @param adminId 管理员编号 * @param oldPassword 旧密码 * @param password 新密码 * @return boolean 是否编辑成功 * @throws UserException * @throws ServiceException */ public booleaneditAdminPass
word(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 文件。