JavaWeb项目开发规范.doc

Java Web项目编程规范 一 目的 1 二 范围 1 三 命名及开发规范 1 3.1 html页面元素命名及开发规范 1 3.1.1 页面元素命名规范 1 3.1.2 页面元素开发规范 2 3.2 脚本变量的命名和开发规范 3 3.2.1 脚本变量命名规范 3 3.2.2 脚本变量开发规范 3 3.2.3 脚本函数以及子过程命名规范 4 四 WEB面页开发规范 4 4.1 客户端程序部分 4 4.2 服务器端程序部分 5 五 Java程序及JSP代码的风格 6 5.1 Java命名 6 5.2 总体风格 6 5.3 类文件风格 8 5.4 方法调用的规范 12 目的 为了保证公司编写出的程序都符合相同的规范，而且便捷，保证一致性、统一性更符合构件化的要求而建立的程序编码规范，要使程序易懂。 范围 适用于企业所有基于Java平台的软件开发工具。 命名及开发规范 所有命名（类、函数、变量..）均要求意义明确易于理解，尽量使用有实际意义的英文单词或英文单词的缩写，更切忌使用中文拼音的首字母。如这样的名称是不提倡的：Value1，Value2，Value3，Value4 …。页面页面Html元素 缩写 例如 text输入框txt txtReason button按钮btn btnCheck select下拉选择框sel selBeginTime option项 opt Checkbox多选项 chk chkProduceNumber form表单frm frmContractQuery frame框架fra fraWorkProcess hidden表单项hdn hdnSteelNumber div标记div divResult span标记 span 对话框对象 dlg 窗口对象win 页面img元素 alt：所有展示类图片都要具有能简要描述图片内容的文字说明。Input元素 maxlength：所有INPUT控件都需要制定maxlength属性，默认值为数据库中对应的字段的长度。readonly：所有不可更改的信息都要使用readonly属性Form元素 action：所有Form都要指定action，如果提交给本身就指定action= method：执行不可逆动作使用POST，可逆动作使用GET onsubmit：所有form都要指定提交前需要的检查程序。button元素 onclick：form中用于提交的button不容许使用此方法，所有数据检查通过form的onsubmit激活。title属性所有页面都要具有和本页标题相同的title。语言设置所有中文页面都要加上如下语句： meta http-equiv=Content-Languagecontent=zh-cn meta http-equiv=Content-Typecontent=text/html;charset=gb2312 元素属性赋值所有的属性值都要使用双引号包括起来。常量以及全局变量名必须全部使用大写字母变量名必须使用其类型的字符串开始。各种类型的字符串如下： 整型变量：int 长整型变量：lng 浮点型变量：flt 双精度变量：dbl 对象引用变量：obj 字符串变量：str Date类型变量：dtm循环依次采用i，j；数组ary 临时变量tmp 变量名必须采用有意义的单词命名，如：strUserName、lngArrayIndex 变量名除首字母小写外，其他单词首字符必须大写 如果变量名过长可以使用单词缩写，除了被广泛了解的单词缩写以外，所有使用单词的变量名必须在定义时给出注释，如：var strAdName //用于表示Administrator帐户的名称 var strAdminName //不用给出注释，Admin被广泛了解变量规范 变量的使用尽量缩小到小的作用域。如循环使用 for(var i = 0; i 12; i++){ } 　　而不是： 　　var ; for(i = 0; I 12; i++){ } 脚本函数以及子过程函数命名必须使用动词＋名词对的方式，并且能够体现函数的功能 函数命名的动词前缀必须是同函数功能相关的完整动词 函数命名第一个单词的首字母小写，后面每一个单词的首字母大写客户端程序部分 错误提示信息的处理 所有错误信息全部使用中文提示错误信息，标点使用中文半角符号，格式如下： 错误：+提示信息+！ 成功提示信息的处理 所有成功信息全部使用中文提示成功信息，标点使用中文半角符号，格式如下： 成功：+提示信息+！ 服务端异常时，如：应用服务器页面不存在异常 （错误代码：404） 应用服务器页面出现错误代码 （错误代码：500） 在web.xml文