JavaScript及HTML编程规范.doc

JavaScript 及 HTML 编程规范JavaScript及HTML编程规范编号：ISS-STD-JS版本:1.0变更记录日期版本变更说明作者目录1导言41.1目的41.2范围41.3角色和职责42HTML标记语言编码规范52.1标记的换行规范52.2标记的关闭规范52.3标记的属性赋值规范52.4标记的缩进规范62.5注释63客户端JavaScript规范73.1变量命名规范73.2变量使用规范73.3对象命名规范83.4函数以及子过程命名规范83.5注释81 导言JSP是一种脚本语言，编码分为两大部分，一部分为静态文件编码，一部分为包含服务器端脚本的动态文件编码。本规范是针对前者，即HTML 和 JavaScript编码的规范1.1 目的本文档旨在提供一个编码的标准，以便所有HTML 和 JavaScript代码在产生的一开始就能够在整个开发团队中保持一致，从而能够更好的阅读和修改代码。1.2 范围本文档适用于昭明海图公司项目开发团队的所有成员，为了使项目的后期维护和修改变得容易，在每个项目开发中一定要遵守本文档中的规定术语定义1.3 角色和职责编码负责人:本规范在具体项目中执行监督负责人。通过实施Source Review 制度，编程人员在完成自己的一个模块并提交测试前，由编码负责人进行Source Review，不符合本编程规约的程序一律打回，重新修改，即编码人你认为自己的程序没有任何的功能问题。编码人员:本规范的遵守者2 HTML标记语言编码规范2.1 标记的换行规范一个标记必须占用一行。不得出现两个标记在同一行的情况(同一标记的关闭标记除外)，如： text 而必须写成： text 2.2 标记的关闭规范l 静态文件内容必须包含在标记中间 l 标记必须包含在标记中间 l 对于需要关闭的标记，如： 、必须同其关闭标记同时出现。如 . 不得出现交叉包含的语句，如： .2.3 标记的属性赋值规范对于接受属性的标记，属性值必须使用双引号包围。如: 2.4 标记的缩进规范l 最高一级的父标记采用左对齐顶格方式书写。 l 下一级标记采用左对齐向右缩进一个Tab的方式书写 l 再下一级依此类推，分别左对齐相对于父标记向右缩进一个Tab的方式书写 同一级标记的首字符上下必须对齐2.5 注释3 客户端JavaScript规范3.1 变量命名规范l 常量以及全局变量名必须全部使用大写字母 l 变量名首字母必须小写。 l 变量名必须使用其类型的所写字符串开始。l 各种类型的所写字符串如下： n 整型变量：n n 长整型变量：l n 浮点型变量：fn 双精度变量：d n 对象引用变量：obj n 字符串变量:str n Date类型变量：dt n 变量名必须采用有意义的单词命名，如： strUserName、lngArrayIndex n 变量名除首字母小写外，其他单词首字符必须大写 n 如果变量名过长可以使用单词缩写，除了被广泛了解的单词缩写以外，所有使用单词所写的变量名必须在定义时给出注释,如： u varstrAdName/用于表示Administrator帐户的名称 u varstrAdminName/不用给出注释，Admin被广泛了解 3.2 变量使用规范l 变量使用前必须定义。没有定义的变量禁止使用(虽然JavaScript中允许，但是做为全局变量) l 变量的使用尽量缩小到小的作用域。n 如循环使用 for(varI=0;I12;I+) /medthod body 而不是： varI; for(I=0;I12,I+) /medthod body 3.3 对象命名规范各种页面对象如text输入框、按钮、下拉选择框在命名时必须使用以下对应前缀： l text输入框:txt l button按钮：btn l select下拉选择框：sel l option项:opt l form表单：frm l frame框架：fra l hidden表单项：hdn l div标记：div l span标记:span l 对话框对象:dlg l 窗口对象：win 3.4 函数以及子过程命名规范l 函数命名必须使用动词名词对的方式，并且能够体现函数的功能 l 函数命名的动词前缀必须是同函数功能相关的完整动词 l 函数命名第一个单词的首字母