javascript编写规范总结.docx

v1.0 可编辑可修改 JavaScript 文件 JavaScript 程序应独立保存在后缀名为 .js 的文件中。 JavaScript 代码不应该被包含在 HTML文件中 , 除非这是段特定只属于此部分的代码。在 HTML 中的 JavaScript 代码会明显增加文件大小 , 而且也不能对其进行缓存和压缩。 应尽量放到 body 的后面。这样可以减少因为载入 script 而造成其他页面内容载入也被延迟 的问题。也没有必要使用 language 或者 type 属性。 MIME类型是由服务器而非 scripttag 来 决定的。 缩进 缩进的单位为四个空格。避免使用 Tab 键来缩进 ( 即使现在已经是 21 世纪了 ), 也始终没有个 统一的 Tab 长短标准。虽然使用空格会增加文件的大小 , 但在局域网中几乎可以忽略 , 且在最 小化过程中也可被消除掉。 每行长度 避免每行超过 80 个字符。当一条语句一行写不下时 , 请考虑折行。在运算符号 , 最好是逗号后 换行。在运算符后换行可以减少因为复制粘贴产生的错误被分号掩盖的几率。下一行应该缩 进 8 个空格。 注释 不要吝啬注释。给以后需要理解你的代码的人们 ( 或许就是你自己 ) 留下信息是非常有用的。 注释应该和它们所注释的代码一样是书写良好且清晰明了。偶尔的小幽默就更不错了。记得 要避免冗长或者情绪化。 1 v1.0 可编辑可修改 及时地更新注释也很重要。错误的注释会让程序更加难以阅读和理解。 让注释有意义。重点在解释那些不容易立即明白的逻辑上。不要把读者的时间浪费在阅读类 似于 : i = 0; / If any of them match the requested name, then append the node to the set of results. if (c) { a = ( ); for (i = 0; i ; i += 1) { if (a[i] === className) { (node); break; } } } }); return results; } 如果函数是匿名函数 , 则在 function 和(( 左括号 ) 之间应有一个空格。 如果省略了空格 , 否则会让人感觉函数名叫作 function 。 = function (e) { return false; }; that = { method: function () { return ; }, datum: 0 }; 尽量不使用全局函数。 命名 变量名应由 26 个大小写字母 (A..Z,a..z),10 个数字 (0..9), 和 _( 下划线 ) 组成。避免使用国际 化字符 ( 如中文 ), 因为它们不是在任何地方都可以被方便的阅读和理解。不要在命名中使用 $( 美元符号 ) 或者 ( 反斜杠 ) 。 不要把 _( 下划线 ) 作为变量名的第一个字符。它有时用来表示私有变量 , 但实际上 JavaScript 并没提供私有变量的功能。如果私有变量很重要 , 那么使用私有成员的形式。应避免使用这 种容易让人误解的命名习惯。 2 v1.0 可编辑可修改 大多数的变量名和方法命应以小写字母开头。 必须与 new 共同使用的构造函数名应以大写字母开头。当 new 被省略时 JavaScript 不会有任 何编译错误或运行错误抛出。忘记加 new 时会让不好的事情发生 ( 比如被当成一般的函数 ), 所 以大写构造函数名是我们来尽量避免这种情况发生的唯一办法。 全局变量应该全部大写。 (JavaScript 没有宏或者常量 , 所以不会因此造成误会 ) 语句 简单语句 每一行最多只包含一条语句。把 ;( 分号 ) 放到每条简单语句的结尾处。注意一个函数赋值或对 象赋值语句也是赋值语句 , 应该以分号结尾。 JavaScript 可以把任何表达式当作一条语句。这很容易隐藏一些错误 , 特别是误加分号的错 误。只有在赋值和调用时 , 表达式才应被当作一条单独的语句。 复合语句 复合语句是被包含在 { }( 大括号 ) 的语句序列。 被括起的语句必须多缩进四个空格。 {( 左大括号 ) 应在复合语句其实行的结尾处。 }( 右大括号 ) 应与 {( 左大括号 ) 的那一行的开头对齐 大括号应该在所有复合语句中使用 , 即使只有一条语句 , 当它们是控制结构的一部分时 , 比如 3 v1.0 可编辑可修改 一个 if 或者 for 语句。这样做可以避免以后添加语句时造成的错误。 标示 语句标示是可选的 , 只有以下语句必须被标示 :while, do,for,switch 。 return 语句 一条有返回值的 return 语句不要使用 (