JavaScript脚本编码规范.doc

JavaScript脚本编码规范 2013年08月01日 修改记录 文件编号 版本号 拟制人/修改人 拟制/修改日期 更改理由 主要更改内容（写要点即可） 20130801090001 1.0 刘杰 2013-08-01 初稿 目录 1 前言 4 2 关于script标签 4 3 脚本嵌入规则 5 3.1 文件方式 5 3.2 脚本段方式 5 4 快速参考 5 5 命名规范 6 5.1 脚本段下的命名 6 5.2 组件下的命名 6 6 特殊命名规范 8 7 变量 8 8 布局 9 8.1 缩进 9 8.2 每行长度 9 8.3 块 9 8.4 空白 11 8.5 注释 11 8.6 参数注释 12 8.7 方法注释 12 9 其他建议 13 9.1 对象及数组的使用 13 9.2 逗号操作符 13 9.3 字符串限定符 13 9.4 赋值表达式 13 9.5 恒等运算符和相等运算符 13 9.6 减少DOM访问 14 9.7 始终使用分号 14 9.8 eval 、setInterval、setTimeout 14 前言 软件的长期价值直接源于其编码质量。在它的整个生命周期里，一个程序可能会被许多人阅读或修改。如果一个程序可以清晰的展现出它的结构和特征，那就能减少在以后对其进行修改时出错的可能性。所有的JavaScript代码都是暴露给公众的所以我们更应该保证其质量。 文件名全为小写字母，单词以下划线分割，后缀名使用*.js。通用代码放在项目根目录下的js目录中，模块专属代码放在模块目录的js目录中。script type=text/javascript src=js/filename.js/script 脚本段方式 当某页面所使用的脚本只在本页面中使用，在项目的其他模块中没有详细代码时，且方法并不是很多，长度并不是很长（总长度不超过200行）的情况下可以采用脚本段方式，如果脚本过长或在项目中多次调用，请把脚本归并到.js文件在页面中调用。”text/javascript” alert(’sample’); /script 命名规范 脚本变量及方法的使用避免缩写。 脚本段下的命名 结构 规则 说明 方法 mixedCase 多个单词组成复合词、首单词小写、其他单词首字母大写 方法内变量 mixedCase 多个单词组成复合词、首单词小写、其他单词首字母大写 页面变量 UPPER_CASE 多个单词组成复合词、每个单词首字母都大写 变量命名 常量以及全局变量必须全部使用大写字母，单词之间用下划线分隔。 var MMS_FRAME, LIMIT_TIME, ALERT_MESSAGE 方法内变量使用多个单词组成复合词，首单词小写，其他单词首字母大写。 var arrSampleList, objSubmitButton 对于指代DOM对象的变量名，尽量使用elm、obj或elm、obj开头命名。 var objSubmitButton = document.getElementById(’btn_submit’); function getCheckElement(name) { var obj = document.getElementById(name); // 没有歧义的方法内部对象命名直接使用obj return obj; } 对于指代字符串对象的变量名，尽量使用str或str开头命名。 var strMaxsizeLimit = ’已超过最大限制’; function alertMessage(message) { var str = message; // 没有歧义的方法内部字符串变量命名直接使用str alert(str); } 对于指代数字的变量名，尽量使用num或num开头命名。 var numMaxCount = 300; function isMaxCount(size) { var num = 1000; // 没有歧义的方法内部数字命名直接使用num return (num size); } 布尔值的变量命名前面加is同理可以为 has, can 或者 should。i, j, k （依次类推）等名称的变量。.... } 用于返回结果变量使用result或者以ret开头的变量。 function getName() { var result; // 或者使用 retName result = ’sina’; return result; } 其他一些建议的约定，例如临时变量使用tmp或以tmp开头的命名；横向纵向坐标x,