文档摘要
版本管理
项目开发编程规范
第一章应用说明及范围
1.总则
编码规范主要是用于统一开发中的编码标准，指导项目组成员的代码文件的规范化，以保证开发团队的协作和系统的后期维护能更好地、有效地进行。
2.目的
本规范约束整个项目的编码规范，要求程序员按规范进行编码设计
第二章数据库命名规范
1.该系统数据库名取名为mydb
2.表名取名为类型名_list
a)publicCustomer_list
b)businessCustomer_list
c)bigCustomer_list
d)specialityCustomer_list
3.数据库字典
商客（）
大客（）
专客（)
第三章JAVA编码规范
1.JAVA文件的注释规范
1.1成员变量的注释
public的成员变量必须生成文档（JavaDoc）。proceted、private和package定义的成员变量可以使用一般注解也可以使用JavaDoc进行注释，所有的成员变量都必须有注释。
privateStringaccountNumber;//账户ID
privateStringaccountCustomerNumber;//客户ID
privateStringaccountBank;//银行账号
privateStringaccountOpenBank;//开户行
privateStringaccountSubBank;//支行
1.2方法的注释
所有方法都必须用JavaDoc进行注释，所有的方法都必须有注释。
/**
*保存一个session对象
*
paramkey变量名称*
paramval传入对应的对象*/
publicvoiddoPost(HttpServletRequestrequest,HttpServletResponseresponse)throwsServletException,IOException{}
1.3方法内部的注释
复杂的方法内部必须有一定数量的注释，注释可以使用单行或多行注释。注释的内容要清楚、明了，含义准确，防止注释二义性。保持注释与其描述的代码相邻，即注释的就近原则；对代码的注释应放在其上方相邻位置，不可放在下面；对结构中的每个变量的注释应放在此变量的右方；同一结构中不同域的注释要对齐。一般使用两种注释方法：
//注释一行
/*......*/注释若干行
2.JAVA元素的命名规则
2.1一般命名约定：
1)尽量使用完整的英文描述符
2)采用适用于相关领域的术语
3)采用大小写混合使名字可读
4)尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一
5)避免使用长的名字（小于15个字母是个好主意）
6)避免使用类似的名字，或者仅仅是大小写不同的名字
7)避免使用下划线（除静态常量等）
2.2命名规范：
3.JAVA的排版规范和元素的先后顺序
3.1排版规范
关键词和操作符之间加适当的空格。
相对独立的程序块与块之间加空行
较长的语句、表达式等要分成多行书写。
划分出的新行要进行适应的缩进，使排版整齐，语句可读。
长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分。
若函数或过程中的参数较长，则要进行适当的划分。
不允许把多个短语句写在一行中，即一行只写一条语句。
函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。
JAVA语言是用大括号‘{’和‘}’界定一段程序块的，编写程序块时‘{’和
‘}’应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
if(i0){i++};//错误,{和}在同一行
if(i0)
{
i++
};//正确,{单独作为一行
if(i0){
i++
3.2元素先后顺序
/*版权版本信息*/
Package/Imports
类定义(包含了在不同的行的extends和implementspublicclassCounterSet)
extendsObservable
implementsCloneable
{
类的成员变量（ClassFields）
类方法
存取方法(get/set方法)
toString方法
构造函数
main方法
}
第四章界面布局、元素大小、排列方式的基本规则
一、格式与缩进
1.最高一级的父标记要求采用左对齐定格格式书写。函数与此一致。
2.下一级标记采用左对齐向右缩进一个TAB的格式书写，再下一级一次类推，分别左对齐相对于父标记向右缩进一个TAB的格式书写。
3.赋值语句(=)及逻辑判断符(!=
...etc)左右各空一格
4.算术运算符左右各空一格
5.if/while/switch之类的语句右边空一格
二、标签引用规则
1.页面引用正确的是标签库，不使用的标签，不要引用相应的标签库。
2.页面引用正确的样式，页面中不需要用的样式，不要引入相应的样式文件。
3.页面中引用正确的JavaScript文件，不要引用没有使用到的JavaScript文件。
4.页面优先采用JSTL标签，其次采用Struts2标签，不建议使用struts2中的表单是标签。
三、页面元素书写规范
1.所有标签的元素和属性的名字都必须使用小写。
2.所有的标记都必须要有一个相应的结束标记。
XHTML要求有严谨的结构，所有标签必须关闭。如果是单独不成对的标签，在标签最后加一个"/"来关闭它（最好是都采用这种方式），例如:
imgheight="80"alt="网页设计师"src="../images/logo_w3cn_x80.gif"width=""/
3.所有元素属性和属性值均必须带双引号。
inputtype=””name=””value=””。
4.所有的XML标记都必须合理嵌套。
因为XHTML要求有严谨的结构，因此所有的嵌套都必须按顺序，以前我们这样写的代码：pb/p/b，必须修改为：pb/b/p，也就是说，一层一层的嵌套必须是严格对称。
5.每个图片标签都必须有ALT说明文字。
imgsrc="ball.jpg"alt="largeredball"title="largeredball"///为了兼容火狐和IE浏览器，对于图片标签，尽量采用alt和title双标签，单纯的alt标签在火狐下没有图片说明
6.JavaScript脚本代码行后必须带上分号结束。
7.JavaScript函数应该都有注释。
//鼠标移出时候添加内容
functionaddContent（）
{
…
}
8.form标记必须的最少属性。
formname=””method=””action=””
…
/form
9.页面中除定位层和特殊需要强调标记的style属性可以放在页面中，其他的均应该
以class属性表示，而这些class内容均应放在外部CSS文件中。
10.JSP中除include指令外的编译指令及动作指令尽量置于JSP文件头
%
pageimport="bookmanager.people.PeopleJB"%%
includefile="../include/authentication_admin.jsf"%html
head
%
includefile="../include/nocache.jsf"%title
/title
linkhref="../style/style.css"rel="stylesheet"type="text/css"
/head
四、命名规范
1.form标记的命名应能说明此表单的用途采用如下形式
“regForm”method=“”action=“”
…
“schForm”method=“”action=“”
…
2.使用EL表达式在jsp页面展现数据
第五章页面各部分应用规则详解
一、页面html前部分
1.指定页面是基于xml标准。
声明页面是基于xml标准生成，并指定xml的版本和字符编码。如下：
?xmlversion="1.0"encoding="UTF-8"?
2.page指令设定页面所使用的字符编码和MINE类型。
用page指信设定网页所使用的字符编码为：UTF－8，MINE类型为：text/html，用Java语言编译JSP网页。如下：
%
pagelanguage="java"contentType="text/html;charset=UTF-8"pageEncoding="UTF-8"%
3.设定页面基本xhtml标准
设置页面使用xml的dtd文档结构和使用xhtml标准。如下:
!DOCTYPEhtmlPUBLIC"-//W3C//DTDXHTML1.0Transitional//EN""TR/xhtml1/DTD/xhtml1-transitional.dtd"
二、页面head部分
1.使用内部js样式
scripttype="text/javascript"
functionmove(moveObj){
vardiv=moveObj;
vartitle=div.children[0];
title.onmousedown=function(e){
//处理兼容问题
e=e
event;
//取得第一次按下去的坐标
X1=e.clientX;
Y1=e.clientY;
//得到文本框相对于，相对于浏览器中坐标
varleft=div.offsetLeft;
vartop=div.offsetTop;
document.onmousemove=function(e){
//鼠标移动的相对位置
varx2=e.clientX-X1;
vary2=e.clientY-Y1;
//定位鼠标移动后文本框的移动位置
varx=x2+left;
vary=y2+top;
varresult="position:absolute;top:"+y+";left:"+x+";";
div.style.cssText=result;
}
}
}
/script
2.引入页面样式。
在页面中引入所使用的样式文件，没有使用到一定不要引入。如下：
linkrel="stylesheet"type="text/css"href="phoneUpdate.css"表示使用phoneUpdate.css样式文件
3.设置页面标题。
标题
三、页面body部分
1.使用标题样式设置标题。
页面中设置标题时，应用样式文件中的样式来设置，以达到界面美观的效果，不要直接引用h/h。
此样式待开发中。
2.设置页面的form格式。
对，需指定基的post,action,name属性，尽量不要空着其属性值。如下：
formaction="cAdd"method="post"id="publicForm"/form
注：cAdd指得是具体业务（用户增加）。