Javaweb开发规范1、前言为了使软件开发过程有章可循，保证软件.doc

Java web 开发规范 1、前言 为了使软件开发过程有章可循，保证软件质量，加强开发管理。 2、开发管理 项目进度周报表格如下： 项目编号 汇报人 汇报日期 项目进度详细描述 其他问题 3、命名规范 3.1 项目编号命名规范 命名方式：项目英文/中午拼音名称_开发组编号_序列号序列号由 3 为数字组成，不足的用’0’补齐。 3.2 文档命名规范 命名方式：项目英文/中午拼音名称_文档名称_序列号_编写人名称/编号 3.3 jsp/html 命名规范 1、jsp 与 html 文件名全部小写，并遵循如下的规范：a.数据/内容显示页: 名词，多个单词用下划线分隔，要求能说明显示内容的信息，为避免冲突，可加上 “_list”。例如： new_message.html 或 my_file_list.jsp b.操作处理页命名格式：名词_下划线_动词，例如：file_delete.jsp。 c.含 frame 页面  本文档由铃灵整理分享  frameset中frame的 name 属性命名的格式是①xxx_②xxx_③xxx ①xxx 部分用来标识当前页面隶属于整个系统中的哪一功能模块。如：属于 ebwebmail 模块则写 ebwebmail，其它情况依次类推。 ②xxx 部分标识当前页面所要完成的功能。 如：完成用户登录的功能则被标识为 login，其它情况依次类推。 ③xxx 部分用来用来表示页面在浏览器窗口所处的位置。 处于浏览器窗口的顶部则标识为 top，其它情况依次类推。例如：ebwebmail_inbox_top.jsp frame src 属性相应的文件名根据情况建议在原命名规范上用下划线加上所处窗口的位置。 2、javascript 脚本文件命名方式： 脚本函数都以①xxx_②xxx 的方式命名。 ①xxx 对应页面隶属的模块。 ②xxx 表示函数所要实现的功能(动宾结构)，多个单词用下划线连接。 例如：ebwebmail_send_mail() 模块通用的脚本函数必须集合于一个 js 文件中，在页面上通过script language=”javascript” src=”url”/script形式导入。js 文件名命名使用模块名，例如：ebwebmail.js。 如果项目已经提供了公共 js 脚本，则优先使用公共 js 脚本中提供的函数。 所有定义方法的script元素定义在head/head中或/body后。 3、javascript 脚本内部变量与参数 单词之间用下划线分隔且全部小写，例如： var file_size。 form表单 name 属性 统一以“form_”开头，其后加该表单所需收集的信息的作用或动作，例如： form_file_upload 或 form_send_mail。 表单 elements 表单 element 的名称以 element 需收集的信息标示命名（与 struts 中的属性名对应），其他 element 单词之间使用下划线分隔且全部小写，例如： input type=”text” name=”username” -username 为 struts 中的属性名 username input type=”radio” name=”file_type” -不与 struts 对应表单元素名 4、cookie 命名 命名格式：模块名_存储信息名词(多个单词用下划线分隔) ，全部大写，例如： EBWEBMAIL_SORT_TYPE。5、window.open 中 name 参数的命名  本文档由铃灵整理分享  javascript 的 window.open 方法中有一个 name 的参数，浏览器约定同样的名字的窗口只能打开一个，如果程序间名字重复将相互冲突。如果不限制打开窗口数，可以指定‘’或“”（不是 null），否则需要加上模块名，例如 ebwebmail_viewmail。 3.4 数据库命名规范 数据库表命名均遵循以下规范： 模块名_存储信息名词(多个单词用下划线分隔)，全部小写，例如：ebwebmail_message。 数据库字段命名遵循以下规范： 存储信息名词(多个单词用下划线分隔)，全部小写，例如：message_id。 4、文档规范 编写文档目前主要使用的工具是 Word（项目计划文档例外，需要使用 Project 制作），辅助使用的工具有 Visio，PowerPoint，Excel 等。 文档务必保持段落格式整齐，文