学员管理系统--JavaScript及HTML编程规范.doc

学员管理系统 JavaScript及HTML编程规范 编号：ISS-STD-JS 版本:1.0 作者： 张晓华 日期： 2010-11-24 审批： 日期： 变更记录 日期 版本 变更说明 作者 目录 1 导言 4 1.1 目的 4 1.2 范围 4 1.3 角色和职责 4 2 HTML标记语言编码规范 5 2.1 样式表的引用 5 2.2 缩进、换行约定 5 2.2.1 缩进 5 2.3 标记的属性赋值规范 7 2.4 注释 7 3 客户端JavaScript规范 8 3.1 变量命名规范 8 3.2 变量使用规范 8 3.3 对象命名规范 9 3.4 函数以及子过程命名规范 9 3.5 JavaScript类 9 3.5.1 声明类 9 3.5.2 使用类 10 3.6 注释 11 导言 JSP是一种脚本语言，编码分为两大部分，一部分为静态文件编码，一部分为包含服务器端脚本的动态文件编码。编码?HTML标记语言编码规范 样式表通过外部引用的方式调用，不建议在页面中新定义样式。 页面元素中的展现形式不建议通过html代码进行定义，都统一使用样式表进行。比如要显示红色字体，用Html代码可以这样进行定义： font clolor=”red”红色字体/font 但最好的方法是通过样式表来定义。 span class=”RedText”红色字段/font 这样可以将对网站样式的定义集中到一个样式表文件中去，如果对网站进行修改，可以很快进行。而如果分散到各个网页文件中去，改动起来就非常麻烦了。 缩进、换行约定 a 、所有的缩进皆为4个空格，所有的缩进是由Space(空格)键形成的，而不是Tab键。如果一行中代码太长，请换行。比如这样一行代码： trtdinput type=”text” name=”test” value=”test” class=”MyInput” onclick=”alert(‘test’)”/td/tr 可以改成： tr td input type=”text” name=”test” value=”test” class=”MyInput” onclick=”alert(‘test’)” /td /tr b、 如果多行相似的代码出现，属性尽量对齐 input type=hidden name=ProjectID value={$ProjectID} input type=hidden name=ModuleID value={$ModuleID} input type=hidden name=BugID value={$BugID} input type=hidden name=AssignedTo value={$AssignedTo} type、name和value属性对齐以后阅读起来比较方便。 c、 对于某种标记的多个属性，其顺序尽量保持一致 比如table标记的定义可以按照下面的顺序来定义。 table width=90% align=center border=0 cellpadding=1 cellspacing=0 class=BgTable ? 规范 a、静态文件内容必须包含在boby /boby标记中间 b、boby标记必须包含在html命名规则 所有的标识符只能用字母（A-Z或a-z）和数字（0-9） 表单中的变量命名采用属性赋值规范对于接受属性的标记，属性值必须使用双引号包围。如: body?bgcolor=”red” ? font?size=”7” 2.6注释 !- - - - 客户端JavaScript规范?变量命名规范常量以及全局变量名必须全部使用大写字母”g_” ?变量名首字母必须小写?变量名必须使用其类型的写字符串开始。各种类型的所写字符串如下：?整型变量： ??? ?长整型变量： ??? ?浮点型变量：?? ?双精度变量： ??? ?对象引用变量：obj ??字符串变量“Paul”); objUserInfo. setLogonID (“Liu”); 注释 函数的功能描述 /* ------------------------------------------------------------------------------- * 功能 ： functionality description * 参数说明： * 反回值说明： *----------------------------------------------------------------------------------/