Jsp /html命名规范

Jsp /html命名规范

葛志春

 

 

对于本项目JSP/html命名请采用如下规范：

实体名 + 功能类型后缀。其中实体名采用：业务对应术语（term）,每个业务术语可由1个或多个单词构成。每一个单词首字母大写，其他字母小写。 当实体名过长时，可以考虑宿写，但宿写必须规范化，统一化，保证一致。 如 ：部门管理 ,全称为：Department Management

规范宿写应该如下： DeptMgmt

 

对于实体名称的后缀请参考如下：

1.       Entity 列表 ：    Entity + List

2.       Entity 详细信息： Entity + Info

3.       Entity 新增：     Entity + New

4.       Entity 修改：     Entity + Edit

5.       Entity 查找：     Entity + Find

6.       Pacakage 框架：    PacakageName + Frmst

菜单：           pacakageName + Menu 

 

 

苏州软件人才实训基地 实施部
2006年8月

修订历史记录
日期 版本 说明 作者
2006-8-29 1．0 吴子敬


目录
1 文件命名与存放位置 4
2 文件组织 5
2.1 开头注释 5
1.2 JSP页面指示语句 6
1.3 可选的JSP标签指示语句 6
1.4 可选的JSP声明语句 6
1.5 HTML与jsp代码 7
2 缩进 7
2.1 脚本元素的缩进 8
2.2 JSP、HTML混排时的缩进 8
3 注释 9
3.1 jsp 注释 9
3.2 客户端注释 10
4 JSP 10
4.1 jsp声明 10
4.2 JSP 脚本 10
4.3 JSP表达式 11
5 空格与空行 11
6 命名规范 11
6.1 jsp文件命名 11
6.2 tag文件命名 11
6.3 11
7 最佳实践 11
8 代码样例 11


1 文件命名与存放位置
文件类型 后缀 建议存放位置
Jsp技术 .jsp <contxt root>/<子系统路径>/
Jsp片断 .jsp <contxt root>/<子系统路径>/
.jspf <contxt root>/web_inf/jspf/<子系统路径>/
样式表 .css <contxt root>/css/
javaScript技术 .js <contxt root>/js/
Html技术 .html <contxt root>/<子系统路径>/
Web资源 .gif,.pig <contxt root>/images/
标签库 .tld <contxt root>/web_inf/tld/

以上<contxt root>是web应用的要路径，而<子系统路径>是系统的逻辑划分，其中包括了静态及动态的页面。
2 文件组织
一个jsp文件应依次包括如下几部份：
开头注释；
Jsp页面指示语句；
可选的jsp标签指示语句；
可选的jsp声明语句；
HTML及jsp代码

2.1 开头注释
开头注释应是服务端样式的一个注释，如所示：


[简要说明此项目的目的与目标，以及此项目将要交付的可交付工件。]
1.2 JSP页面指示语句
如所示，是一个JSP页面指示语句的样例：


1.3 可选的JSP标签指示语句


如果标签指示符过长，则使用以下格式


1.4 可选的JSP声明语句

[说明项目团队（包括管理部门和其他复审权威部门）的组织结构。]

1.5 HTML与jsp代码
Jsp页面的这部份包括了HTML部份及jsp代码，如jsp表达式，jsp的脚本等。
[说明开发本软件项目所需要的软硬件环境和版本、如操作系统、开发工具、数据库系统、配置管理工具、网络环境。]


2 缩进
不用[tab]缩进，而应用字符缩进，缩进的单位是4个字符；如：



[本节用图形的形式表示实体及实体间的关系]
2.1 脚本元素的缩进


若脚本元素过长，则下一行缩进四个字符，且”%>”另起一行。


[对于项目开发中需完成的各项工作，从需求分析、设计、实现、测试直到维护，包括文件的编制、审批、打印、分发工作，用户培训工作，软件安装工作等，按层次进行分解，指明每项任务的负责人和参加人员。]

2.2 JSP、HTML混排时的缩进



要优于：





3 注释
3.1 jsp 注释
Jsp注释又称为服务器端注释，这种注释对客户端是不可见的。Jsp注释可分为两种，即脚本内的java风格的注释及纯jsp注释，见表，推荐使用纯jsp风格的注释；


行 脚本语言内的注释 纯jsp注释
单行 <% /** ... */ %><% /* ... */ %><% // ... %> <%-- ... --%>
多行 <% /* * ... * */ %> <%-- - …… -%>
<%……//%>

3.2 客户端注释
客户端注释即HTML注释，其形式是(<!-- … -->)，一般不携荐使用。



4 JSP
4.1 jsp声明
Jsp声明应遵循java声明的编码规范，如一行仅声明一个变量，



4.2 JSP 脚本
理想情况下，JSP页面中应没有jsp脚本，这样可以避免在表现层实现业务逻辑，并尽可能地使用标签处理服务器端的信息

4.3 JSP表达式
有三种方式实现JSP表达式，即：
显式的java代码，如： <%=myBean.getName()%>
Jsp标签，如：<jsp:setProperty name=”myBean” propertyr=”name”/>
表达式语言：<c:out value=”${myBean.name}”/>
推荐使用表达式语言方式，一般不使用jsp标签方式。

5 空格与空行
6 命名规范
6.1 jsp文件命名
Jsp文件应以小写字母开始，可以由多个单词组成，后面的单词首字母大写，jsp文件名应是一个名词或是简短的句子。
6.2 tag文件命名

6.3

7 最佳实践
8 代码样例