java web开发规范.docxVIP

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.jspb.操作处理页　命名格式：名词_下划线_动词，例如：file_delete.jsp。c.含frame页面frameset中frame的name属性命名的格式是①xxx_②xxx_③xxx?①xxx部分用来标识当前页面隶属于整个系统中的哪一功能模块。如：属于ebwebmail模块则写ebwebmail，其它情况依次类推。?②xxx部分标识当前页面所要完成的功能。如：完成用户登录的功能则被标识为login，其它情况依次类推。③xxx部分用来用来表示页面在浏览器窗口所处的位置。?处于浏览器窗口的顶部则标识为top，其它情况依次类推。例如：ebwebmail_inbox_top.jspframe 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中的属性名usernameinput 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等。文档务必保持段落格式整齐，文字字体，颜色，大小统一。如果需要摘引html页面中的内容，不能直接从html中粘贴过来（会在word文档中留下html格式），而必须先去除格式，例如：先粘贴到notepad中。务必注意中英文标点符号，文档正文一概使用中文标点符号。如果需要在文档中插图，不要使用word自带的绘图工具。可以选择使用PowerPoint或visio。使用PowerPoint，选择“插入”-“对象”-“Microsoft PowerPoint 幻灯片”。使用visio，需要另外建立visio文档，绘制完以后粘贴到word中。数据建模使用po