看公司了。要正规的话可以看看CMM的格式。我在东软作国类似稳当

解决方案 »

  1.   

    1、一定要注释的;
    2、另外要注意标记的对称性和封闭性,最好让每一个标记对都闭合;
    3、java代码中的变量命名最好符合java文件中的规范;
    4、可以用try …catch包含html代码,捕获发生的异常。
      

  2.   

    JSP开发规范
    1 系统平台和技术
    系统平台:Windows 2000 Server(或Windows 2000 Advanced Server)/TOMCAT4
    数据库:ORACLE9I
    开发平台:Macromedia Dreamweaver MX 6.0、JBUILDER7、JBUILDER9
    技术:Jsp1.2
    语言:JAVA、JAVAVScript
    测试平台:Microsoft Internet Explorer 4.0/5.0/6.0
    网页适用屏幕大小:800×600(实际尺寸776×434px)或1024×768
    2 网站总体组织结构
    为了便于网站维护,制定以下网站总体组织结构规范:
    2.1 网站组织
    目录结构不要太深,太深的目录结构会导致较长的URL。
    ² 多数页面共有的部分放入SSI(Server Side Include)包含文件中,例如:每页的头部广告条、尾部导航条和版权信息。
    ² 采用外部链接的CSS(Cascading Style Sheet)层叠样式表,对CSS的引用统一。
    ² 尽量不要采用嵌套超过3层的表格和太复杂的表格,嵌套表格太多,浏览器解释HTML代码的时间越长。
    ² 引用网站内部资源采用相对路径链接;引用别的资源采用带域名的绝对路径链接,不要采用不带域名的绝对路径链接;链接别的资源尽量采用域名而不用IP地址的形式。非要用IP地址,这IP地址必须是Internet的合法地址。
    2.2 目录结构
    2.2.1 目录与文件的分类
    ² 可执行文件与组件放入\scripts目录(此目录的执行权限必须严格设定)
    ² 图标与图片文件放入\images目录
    ² 模板文件放入\templates目录
    ² CSS样式文件、包含文件放入\include目录
    ² 库文件放入\WEB-INF\CLASSES目录
    ² 如网站为多语种版本,则每个语言版本存放于独立的目录(其他语种依此类推)。例如:
    n 简体中文 \gb2312
    n 繁体中文 \big5
    n 英语 \en
    n 日语 \jp
    ² 各个模块放入各个模块对应目录,命名尽量采用英文缩写方式
    2.2.2 目录与文件的命名
    ² 在JSP脚本环境中不使用中文字符命名文件名,尽可能使用英文或英文缩写字符命名文件名,减少使用汉语拼音命名文件名。
    ² 目录名字母全部小写。
    ² 文件名统一用英文字母、数字和下划线的组合。index.jsp、index.html、default.jsp、default.html文件名用小写。
    2.2.2.1 主框架文件
    采用default.Jsp 、 index.jsp 、 default.htm 、 index.htm(静态文本统一采用.htm后缀)
    2.2.2.2 包含文件
    包含文件全部采用.jsp后缀结尾
    2.2.2.3 图标、图形文件
    ² 采用通用的英文缩写命名。
    ² 名称分为头尾两个部分,用下划线隔开。
    ² 头部分表示此图片的大类性质,例如:广告、标志、菜单、按钮等等。
    ² 放置在页面顶部的广告、装饰图案等长方形的图片取名:banner_name
    (全尺寸banner为468×60px,半尺寸banner为234×60px,小banner为88×31px,另外120×90,120×60也是小图标的标准尺寸)
    ² 标志性的图片取名:logo_name
    ² 页面上位置不固定且带有链接的小图片取名:button_name
    ² 在页面上某个位置连续出现且性质相同的链接栏目图片取名:menu_name
    ² 装饰用图片取名:pic_name
    ² 不带链接的标题图片取名:title_name
    其他图片按照此原则类推。
    3 页面的设计规范
    ² 页面背景采用浅色和纯色且直接使用16进制颜色定义,不要使用色图定义颜色。
    &sup2; 页面长度<=3屏,多于3屏的页面采用锚连接(anchor)到其它页或用分页显示,并增加“首页”、“上一页”、“下一页”、“尾页”、“调转到_页”等类型的链接。
    &sup2; 页面宽度<=1屏。
    &sup2; 每个标准页面为A4幅面大小,即8.5×11英寸。
    &sup2; 正在建设的网页,不开通其链接,不要链接到“正在建设中”一类的页面。
    &sup2; 一般不使用Frame帧结构,只有在使用聊天室一类的特殊页面时才使用。
    &sup2; 使用Flash动画。
    &sup2; 没有特殊情况,不使用Java Applet。
    &sup2; 所有字号都应该采用样式表来实现,禁止在页面中出现<font size=?>标记。
    &sup2; 最大程度的发挥浏览器自动排版功能,在一段文字中请尽量不要使用<br>来人工干预分段。
    &sup2; 中英文混排时,英文和数字定义为Verdana和Arial两种字体。
    &sup2; 行距建议用百分比来定义,常用的两个行距值为:line-height:120%/150%
    &sup2; 表格定义使用像素。采用百分比会使表格根据屏幕大小自动调整。
    &sup2; 所有的图片都定义高度和宽度,并加上替代文本(即定义:Alt=”替代文本”),同时替代文本要与主题一致。
    &sup2; CSS文件格式样例代码:
    <style type=”text/css”>
    <!--
    p{text-indent:2em;}
    body{font-family:”宋体”;
    font-size:10.5pt;line-height:20px;color:#0099FF;letter-spacing:5em}
    -->
    </style>
    &sup2; a:link a:visited a:hover a:active 的排列顺序一定要严格按照上面的样例顺序。重定义的最先,伪类其次,自定义最后。便于他人阅读。
    &sup2; 为保证不同浏览器上字号一致,字号采用点数pt和像素px来定义。pt一般使用中文宋体的9pt和11pt,px一般使用中文宋体12px和14.7px。黑体字或者宋体字加粗时一般选用11pt和14.7px字号比较合适。
    &sup2; 排版中遇到首行缩进的处理,不要使用&nbsp;或者全角空格来达到效果,规范的做法是定义p{text-indent:2em;}。然后给每段加上<p>标记,请勿搞忘</p>关闭标记。
    4 HTML编码规范
    JSP编码分为两大部分:静态文件编码(HTML)和动态文件编码(JSP)。
    静态文件脚本部分采用JAVAScript编写,输出部分采用HTML标记语言。&sup2; 每个页面都要有简明准确的Title。
    &sup2; 保持干净的HTML代码,自动或手动清除多余Tag。
    &sup2; 不使用BLINK标记。
    &sup2; 为保证页面对浏览器的兼容性,不要使用某种浏览器专用的标识,例如:marquee,layer,nobr等。
    &sup2; meta标记标准格式
    <meta http-equiv=”content-type” content=”text/html;charset=gb2312”>
    &sup2; 其他meta标记
    <meta name=”author” content=”goldtel”>
    &sup2; 允许全文检索的页面meta标记
    <meta name=”keywords” content=”国腾信息安全,信息安全,软件”>
    <meta name=”description” content=”国腾信息安全,电力行业软件全国老大”>
    &sup2; 样式表定义
    <link rel=”stylesheet” type=”text/css” href=”style/style.css”>
    &sup2; 保证网站能够与下一代Web语言XML标准兼容,所有的HTML标签的属性都要用单引号或者双引号括起,例如:<a href=”url”>而不是<a href=url>
    &sup2; 采用DW MX 6中的Command->apply source formatting进行源代码格式整理
    &sup2; 标记的换行规范
    一个标记必须占用一行。不得出现两个标记在同一行的情况(同一标记的关闭标记出外)
    例如:
    <tr><td>text</td></tr> 错误格式<tr>
    <td>text</td> 正确格式
    </tr>
    &sup2; 标记的关闭规范
    静态文件内容必须包含在<body></body>标记中间
    <body>标记必须包含在<html></html>标记中间
    对于需要关闭的标记,
    <html><title><body><table><tr><td><p><textarea><select><font><option><div><span>等
    必须同其关闭标记同时出现。例如:
    <body>…<p>…<font>…</font>…</p>…</body> 正确格式
    不得出现交叉包含的语句。例如:
    <p>…<font>…</p>…</font> 错误格式
    &sup2; 标记的属性赋值规范
    对于接受属性的标记,属性值必须使用双引号或者单引号包围。例如:
    <body bgcolor=”red”>
    <font size=’7’>
    &sup2; 标记的缩进规范
    最高一级的父标记采用左对齐顶格方式书写。
    下一级标记采用左对齐向右缩进2个字符的方式书写,在下一级依此类推,分别左对齐向对于父标记向右缩进2个字符的方式书写。
    同一标记的首字符上下必须对齐。
      

  3.   

    5 WEB技术规范
    服务器端脚本书写采用JAVA书写。
    动态文件客户端脚本一律采用JAVAScript书写,必须符合静态文件编码规范中有关JAVAScript编码规范的规定。
    5.1 编码基本格式
    &sup2; 缩进  每层缩进两个空格,不要把tab字符存入源文件(因为tab的宽度可变)。
    &sup2; 括号  括号与其后续或前置字符之间不要留有空格,不要使用多余的括号。
    5.2 常量和变量
    &sup2; 定义变量时请注明变量的意义。
    &sup2; 变量名必须采用有意义的单词命名,例如:strUserName、lngArrayIndex
    &sup2; 变量名首个字母必须小写,其他单词首字符必须大写。
    &sup2; 变量名过长可以使用单词缩写,除了被广泛了解的单词缩写以外,所有使用单词缩写的变量名必须在定义时给出注释,例如:
    var strAdName //用于表示Administrator帐户的名称
    var strAdminName //不用给出注释,Admin被广泛了解
    &sup2; 名字尽量不要超过32个字符。
    &sup2; 常量以及全局变量必须全部使用大写字母。
    &sup2; 常量必须使用CONST_前缀。
    &sup2; 全局变量必须使用G_前缀。
    &sup2; 循环控制变量:可以使用简单的单字符命名,如i,j,k。
    &sup2; 布尔变量:清楚表明值为true或false时的不同含义。
    &sup2; DataStart和DateEnd比StartDate和StartEnd更好,因为这两个相关函数将在搜索中相互跟随。
    &sup2; 避免使用容易混淆的缩写词,例如:Date、Price、Name、Number,因为通常不止有一个这样的变量,如NameFirsr、NameLast。
    &sup2; 对不同的变量绝对不能使用相同的变量名,不管这两个变量是否会冲突。
    &sup2; 在过程和函数中,使用像P_ 或 F_ 的代码字母作为名字的开始。
    &sup2; JAVAScript中,变量名不能超过255个字符。
    &sup2; 所有变量名以字母开始,只能包含下划线和数字。
    &sup2; JAVAScript中变量名区分大小写。
    &sup2; Cookie中变量名前加一个c。
    &sup2; 考虑用户关闭Cookie的情况,一般不要使用Cookie。
    &sup2; 变量名必须使用其类型的缩写字符串开始。尽管两种脚本语言中ASP使用的所有变量类型都是Variant类型的,但是用变量名来区分存储在其中的数据类型是非常有用的。各种类型的缩写字符串如下:
    变量类型 前缀
    布尔型(Boolean) bln
    字节型(Byte) byt
    日期/时间型(Date/Time) dat或dtm
    集合型(Collection) col
    双精度型(Double) dbl
    整型(Integer) int
    长整型(Long) lng
    对象型(Object) obj
    单精度型(Single) sng
    字符型(String) str
    &sup2; 常用变量命名规范示例
    说明:包含在[]中的部分为可以省略的部分
    Connection对象:con[Name]。Name为所连接数据库服务器名字。
    Recordset对象:rst[Name]。Name为自定义的同rst存储内容有关的英文单词组合。
    Statement对象:stmt[Name]。Name为自定义的同Statement目的有关的英文单词组合。
    SQL语句字符串变量:strSQL[CommandName]。CommandName为自定义的同SQL语句功能相关的英文单词组合,例如:
    strSQLUpdateModify
    strSQLInsertUser
    &sup2; 过程中不改变记录类型、数组类型、短字符串类型的值,将其声明为const。
    5.3 保留字与关键字
    全部使用小写。
    5.4 形参
    类型相同的形参合并声明:void Tsm(String Param1,String Param2,Stirng Param3,int Param4);参数的顺序:使用频率高的参数放在前面,输入数据的参数放在输出数据的参数前面,所指范围广的参数放在范围小的前面。
    5.5 HTML同服务器端脚本混合使用原则
    &sup2; 服务器端脚本标记”<%”必须同其上一行紧邻的标记左对齐,例如:
    <table>
    <%
    Do While rst.next
    {
    %>
    <tr>
    <td>text</td>
    </tr>
    <%

    }
    %>
    </table>
    &sup2; 服务器端脚本标记”<%”同其后的代码不得在同一行书写,“%>”同其前面的代码不得在同一行书写。
    &sup2; 服务器端脚本标记”%>”同其最近的”<%”标记对齐。
    &sup2; 服务器端内部的HTML代码依据静态文件的HTML缩进规则编写,不遵循服务器端脚本缩进规则。
    &sup2; HTML标记内部的代码,依据服务器端脚本的缩进规则,不遵循HTML代码缩进规则。
    5.6 方法命名规范
    &sup2; 首字母小写,各个独立单词的首字母大写。
    &sup2; 函数命名必须使用动词+名次对的方式,并且能够体现函数的功能。
    &sup2; 函数命名的动词前缀必须是同函数功能相关的完整动词。
    &sup2; 函数命名第一个单词的首字母小写,后面每一个单词的首字母大写。
    命名原则:动词+描述性字符(总长度在20个字符以内);执行某项操作的程序段以相应的动词开始,赋值的过程应以set(小写)开始; 取值的过程以get(小写)开始。
    功能分离:通用模块、行业应用模块。
    5.7 对象命名规范
    各种对象如Connection、Recordset、Statement在命名时必须使用以下对应前缀:
    对象名 前缀名
    Connection对象 con
    Recordset对象 rst
    Statement对象 stmt
    PrepareStatement对象 pstmt
      

  4.   

    使用变量前缀:变量类型   前缀
    布尔型(Boolean) bln
    字节型(Byte) byt
    日期/时间型(Date/Time) dat或dtm
    集合型(Collection) col
    双精度型(Double) dbl
    整型(Integer) int
    长整型(Long) lng
    对象型(Object) obj
    单精度型(Single) sng
    字符型(String) str