javaweb开发规范Word文档下载推荐.docx
《javaweb开发规范Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《javaweb开发规范Word文档下载推荐.docx（11页珍藏版）》请在冰点文库上搜索。
script>
元素定义在<
head>
<
/head>
中或<
/body>
后。
3、javascript脚本内部变量与参数
单词之间用下划线分隔且全部小写，例如：
varfile_size。
<
form>
表单name属性
统一以“form_”开头，其后加该表单所需收集的信息的作用或动作，例如：
form_file_upload或form_send_mail。
表单elements
表单element的名称以element需收集的信息标示命名（与struts中的属性名对应），其他element单词之间使用下划线分隔且全部小写，例如：
inputtype=”text”name=”username”>
-username为struts中的属性名username
inputtype=”radio”name=”file_type”>
-不与struts对应表单元素名
4、cookie命名
命名格式：
模块名_存储信息名词（多个单词用下划线分隔），全部大写，例如：
EBWEBMAIL_SORT_TYPE。
5、window.open中name参数的命名
javascript的window.open方法中有一个name的参数，浏览器约定同样的名字的窗口只能打开一个，如果程序间名字重复将相互冲突。
如果不限制打开窗口数，可以指定‘’或“”（不是null），否则需要加上模块名，例如ebwebmail_viewmail。
4数据库命名规范
数据库表名规范
模块名_存储信息名词（多个单词用下划线分隔），全部大写，例如：
SYSM_ROLE
数据库字段名规范
存储信息名词（多个单词用下划线分隔），全部小写，例如：
message_id。
5文档规范
1.编写文档目前主要使用的工具是Word（项目计划文档例外，需要使用Project制作），辅助使用的工具有Visio，PowerPoint，Excel等。
2.文档务必保持段落格式整齐，文字字体，颜色，大小统一。
3.修改文档时，需要在文档的第2页填写修改或者增减内容，以及修改时间，修改人。
文档采用新增的方式进行修改。
修改规则如下
1.细小变动，如错别字修改等，直接在原版本的基础上进行修改
2.变动内容较小，但是有新增内容，保留原版本，在原版本上进行修改，并将版本号的第三位向前滚动1位。
在提交
3.变动内容较多，有较多的增补和变化，版本号第2位向前滚动
4.文档发生根本性变化，例如整体结构和目录发生了重大变更，版本号向前滚动1位。
6编码码规范
Java代码规范
命名规范
Package的命名
Package的名字应该都是由一个小写单词组成，例如：
net.venustech.modules。
java类的命名
Class的名字必须由大写字母开头而其他字母都小写的单词组成，例如：
DataFile或InfoParser。
Class变量的命名
变量的名字必须用一个小写字母开头。
后面的单词用大写字母开头，例如：
debug或inputFileSize。
方法的命名
方法的命名以一个小写字母开头。
debugMethod（）或inputFile（）。
StaticFinal变量的命名
StaticFinal变量的名字应该都大写，并且指出完整含义，例如：
MAX_UPLOAD_FILE_SIZE=1024。
参数的命名
参数的名字必须和变量的命名规范一致。
使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：
setSize（intsize）
{
this.size=size;
}
数组的命名
数组应该总是用下面的方式来命名：
byte[]buffer;
而不是：
bytebuffer[];
代码格式规范
文件头声明
源文件的头部需要一个history段，对于每次对源文件的重大改动，都需要在history段中注明。
该段定义在package和 import之间，例如：
／*****************************************************
*HISTORY
*
*2002/01/29Biz创建文件
*2002/02/19kevin增加XX功能
*
*2002/03/01ben增加xx功能
*******************************************************/
代码块书写格式
主要为大括号的方式
if（true）{
//body
}
对于代码块过长，超过1屏以上，}后面要说明属于那个代码块，例如：
if（i>
100）
//toomanylinesmorethanonescreen
}//if（i>
100）
操作符
赋值，判断等符号需要在2边的变量加1各空格
inta=b;
if（a>
0）;
SQL语句
代码中书写的sql语句要求sql关键字全部大写，表名和字段名小写。
例如：
SELECTuser_id,nameFROMaccountWHEREuser_id>
?
ANDdepart=?
ORDERBYname
类和方法定义
类定义或方法定义过长需要换行书写
注释
每个方法前最少需要添加功能说明的注释
其他
关于属性
类中的属性不能定义为public变量直接存取，而是定义成protect变量并编写get/set方法，例如：
protectStringmyName;
publicStringgetMyName（）
returnmyName;
}
publicvoidsetMyName（StringmyName）
this.myName=myName;
jsp/html代码规范
jsp/html描述注释
jsp/html页面顶部必须存在一个基本描述注释，包含功能描述、参数列表和历史修改信息，例如：
%--
/**************************************************
*
*NAME:
file_download.jsp
*PURPOSE:
下载文件提示
*PARAMETERS:
*file_id-文件ID号
*force?
C是否强制下载
*HISTORY
*2002/04/05Hafele创建文件
*2002/06/07tmp增加强制下载功能
*************************************************/
--%>
Html/jsp格式
html头格式：
<
metahttp-equiv="
Content-Type"
content="
text/html;
charset=utf-8"
>
title>
sometitle<
/title>
linkrel="
stylesheet"
href="
some.css"
type="
text/css"
scriptlanguage="
javascript"
//somejavascript
/script>
注意：
必须指定一个有意义的<
，严禁出现“Untitled”或“未命名”之类的<
。
所有html标签使用小写
Html/jsp语法校验
在默认的ide设置中，不允许出现html和jsp的语法错误
一般不使用html注释，除非是有必要让最终用户看到的内容。
对于包含JSP代码的html块，必须使用JSP注释。
对于没有必要的注释，在发行版本中必须移除。
form属于域的maxlength
对于text类型的输入域，必须根据数据库字段的长度设置相应的maxlength，例如数据库类型是VARCHAR（64），那么maxlength是32（因为中文浏览器对于中文也认为是一个字符）。
76、项目规范
6.1应用程序目录规范
6.1.1Java源文件目录
目录名
说明
src
（Java源代码）
|_cn
域名倒置
|_farmers
域名
|_common
公用包
|_util
工具包
|_db
数据库访问类
|_…
其他公用包
|_action
公用的action类包
|_模块名
模块功能实现包
|_dao
数据库访问类包
|_biz
模块业务实现类包
模块专用action类包
6.1.2Web应用程序目录规范
webpage
（Web页面源代码）
|_images
页面图片
|_js
Javascript源代码
|_css
样式表文件
|_admin
系统管理功能
系统管理模块功能实现页面
业务模块功能实现页面
|_web-inf
Web.xml等文件存放目录
|_classes
Java类class文件目录
*.properties
配置文件
|_lib
应用程序所需类包
|_config
系统配置信息
8IDE规范
对于IDE的使用,限制使用为eclipse。
9外部包的使用
开发员如果需要使用一个外部包需要听取项目经理的意见。
在项目经理批准以前，严禁擅自使用一个外部的包。
升级会员 