jsp/html开发规范
jsp
与
html
文件名全部小写，存放位置应该按照功能块分开来存放，不允许前台和后台公共使用某个页面，但是允许共用
css
、
javascript
、图片等。并遵循如下的规范：
1
数据
/
内容显示页
名词，多个单词用下划线分隔，要求能说明显示内容的信息，为避免冲突，可加上
“_list”
。例如：
new_message.html
或
my_file_list.jsp
2
操作处理页
命名格式：名词
_
下划线
_
动词，例如：
file_delete.jsp
。
3
含
frame
页面
<frameset>
中
<frame>
的
name
属性命名的格式是①
xxx._
②
xxx_
③
xxx
①
xxx
部分用来标识当前页面隶属于整个系统中的哪一功能模块。
如：属于
ebwebmail
则被表示为
ebwebmail
，其它情况依次类推。
②
xxx
部分标识当前页面所要完成的功能。
如：完成用户登录的功能则被标识为
login
，其它情况依次类推。
③
xxx
部分用来用来表示页面在浏览器窗口所处的位置。
处于浏览器窗口的顶部则标识为
top
，其它情况依次类推。
例如：
ebwebmail_inbox_top.jsp
<frame> src
属性相应的文件名根据情况建议在原命名规范上用下划线加上所处窗口的位置。
4
javascript
脚本方法
脚本函数都以①
xxx_
②
xxx
的方式命名。
①
xxx
对应页面隶属的模块。
②
xxx
表示函数所要实现的功能
(
动宾结构
)
，多个单词用下划线连接。
例如：
ebwebmail_send_mail()
模块通用的脚本函数必须集合于一个
js
文件中，在页面上通过
<script language=”javascript” src=”url”></script>
形式导入。
js
文件名命名使用模块名，例如：
ebwebmail.js
。
如果项目已经提供了公共
js
脚本，则优先使用公共
js
脚本中提供的函数。
所有定义方法的
<script>
元素定义在
<head></head>
中或
</body>
后。
5
javascript
脚本内部变量与参数
单词之间用下划线分隔且全部小写，例如：
var file_size
。
6
<form>
表单
name
属性
统一以
“form_”
开头，其后加该表单所需收集的信息的作用或动作，例如：
form_file_upload
或
form_send_mail
。
7
表单
elements
表单
element
的名称以
element
需收集的信息标示命名，单词之间使用下划线分隔且全部小写，例如：
<input type=”text” name=”username”>
<input type=”radio” name=”file_type”>
<textarea name=”content” rows=”5” cols=”40”>
另：一定要写
JavaScript
来验证表单内容
8
cookie
命名
命名格式：模块名
_
存储信息名词
(
多个单词用下划线分隔
)
，全部大写，例如：
EBWEBMAIL_SORT_TYPE
。
9
window.open
中
name
参数的命名
javascript
的
window.open
方法中有一个
name
的参数，浏览器约定同样的名字的窗口只能打开一个，如果程序间名字重复将相互冲突。如果不限制打开窗口数，可以指定
‘’
或
“”
（不是
null
），否则需要加上模块名，例如
ebwebmail_viewmail
。
10
jsp/html
描述注释
jsp
/html
页
面顶部必须存在一个基本描述注释，包含功能描述、参数列表和历史修改信息，
例如：
<%--
/**************************************************
*
* NAME : file_download.jsp
*
* PURPOSE :
下载文件提示
*
* PARAMETERS :
* file_id -
文件
ID
号
* force –
是否强制下载
*
* HISTORY
*
* 2002/04/05 Hafele
创建文件
*
* 2002/06/07 tmp
增加强制下在功能
*
*************************************************/
--%>
11
Jsp
头格式
jsp
头部一般需要遵循以下格式：
<%@ page contentType="text/html; charset=ISO8859_1" errorPage="/error.jsp" buffer="128kb"%>
如果需要
import
包。则：
<%@ page import="java.util.Vector,
javax.mail.*,
com.chinabyte.common.*"%>
//
一般
jsp
都需要防止缓存，这点可以在
filter
中完成
示例代码如下
response.setHeader("Pragma","No-cache");
response.setHeader("Cache-Control","no-cache");
response.setHeader("Expires","0");
12
html
格式
html
头一般需要遵循以下格式：
<head>
<meta http-equiv="Content-Type" content="text/html; charset=gb2312">
<title>some title</title>
<link rel="stylesheet" href="some.css" type="text/css">
<script language="javascript">
//some javascript
</script>
</head>
注意：必须指定一个有意义的
<title>
，严禁出现
“Untitled”
或
“
未命名
”
之类的
<title>
。
所有
html
标签使用小写
html
页面一般需要设置一个背景色（一般是
#FFFFFF
）。
13
html
语法校验
所有的
jsp/html
页面需要能够使用
DreamWeaver
正确打开（即
html
语法正确，没有错误的标记）。
14
注释一般不使用
html
注释，
除非是有必要让最终用户看到的内容。对于包含
JSP
代码的
html
块，必须使用
JSP
注释。对于没有必要的注释，在发行版本中必须移除。
15
form
属于域的
maxlength
对于
text
类型的输入域，必须根据数据库字段的长度设置相应的
maxlength
，例如数据库类型是
VARCHAR(64)
，那么
maxlength
是
32
（因为中文浏览器对于中文也认为是一个字符）。