前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >js代码规范

js代码规范

作者头像
RobinsonZhang
发布2018-08-28 11:41:52
8.8K0
发布2018-08-28 11:41:52
举报

前言

在js的代码开发中,我简单的总结出了以下规则,后面会陆续补充并且对规范进行分类。

  1. js代码建议保存到后缀名.js的文件中
  2. js代码不建议放在html中,原因有:不能被缓存,会增大网页文件的大小,可维护性不高,会影响页面的加载。另外脚本的lang(已弃用)以及type(默认是text/javascript)属性都可以省略。
  3. 缩进,建议使用空格,因为各个环境对tab的解释不通,而空格可以在压缩文件中统一被压缩掉。
  4. 每行控制在80个字符以内,如果超过请折行。
  5. 注释 : 注释可以增加代码的可维护性,尤其在项目交接的时候。 写好注释有利于团队的集成开发。 在更新功能以及模块时通过注释进行补充说明。 写有意义的注释,关键位置的说明。 单行注释:// 多行注释:/* */ 段落注释 模块注释 方法注释: /* * 这里是一段注释 * 这里的注释可以连写多行 */
  6. 变量声明: 在所有的变量使用前进行声明; 多个变量同时命名时,可以简化用,分割同时命名; 变量命名,jq的变量以$开头,比如常用的$this,私有变量以_开始; 变量没有块的概念; 注意全局变量与布局变量,避免使用全局变量,同时避免局部变量覆盖全局变量。 在函数体内,注意函数变量的说明,函数内使用到的变量要在函数头部进行尽量统一声明,尤其很多入参或者出参的时候。
  7. 函数声明: 所有的函数应该在使用前被声明; 函数声明格式,函数名与左括号无间隔,右括号与方法体大括号有空格,大括号结束符与方法声明行头部对齐。(快捷键crtl+shift+f) 特别的,如果是匿名函数,应该在方法类型与小括号之间加空格。
  8. 命名 : 变量名由26个大小写引文字母以及下划线组成,避免使用中文,不要再变量名中使用斜杠或者美元符号,不要把下划线用作变量的第一个字符,它有时会用作对象的私有变量,大多数的变量或者方法名应该以小写字母开头。 全局变量应该全部大写字母。
  9. 语句 : 9.1 简单语句 每一行语句最多只包含一条语句,吧分号放在每个简单语句的结尾。注意每个变量或者对象的赋值语句也是简单语句,应该以分号结尾。 js吧任何表达式都当一条简单语句,会导致一些隐性的错误。如果自己没加分号,那么js解释器会自动添加分号,按照自己能读懂的断句。 9.2 复合语句 也称为语句块,被包在大括号内部。 内部的语句块需要缩进四个空格,左大括号在起始行的结尾处,右大括号与左大括号所在行的开头对齐。 大括号要在使用语句块的时候使用,哪怕只有一句,这样可以避免以后再添加语句的时候造成逻辑错误,比如if else 这样的语句中,默认只对单行代码有效 。
  10. 标识 : 标识是可选的,只有在do,while,for,switch中使用。
  11. return 语句 当返回语句只有一条返回值的时候,不用加小括号; 当返回语句多个值的时候,小括号。 当返回表达式的时候,应该控制在同一行,分号结尾。
  12. 基本语句的格式,按照正确的句法,比如if,else,for,switch 等
  13. 空白 : 相关程序之间添加空白行增强程序的可读性。 每个控制结构,比如for循环的三个分支之间。 变量声明时每个逗号之间。
  14. 变量作用域 js没有有块级作用域,只有函数作用域。
  15. [] {} 的用法 使用直接量发来声明对象和数组。 比如对象 var obj={} ;var arr=[]
  16. eval eval是最容易混乱使用的js函数,他可以执行内部入参的js函数或者表达式,可以直接解析变量。不建议使用 。
  17. 不建议修改内建对象的原型链 内建对象的原型链 是比较好的标准 自己不要修改内建对象的相关方法 在内建对象的es5 es6 语法中有哪些
  18. this关键字的使用场景 : 全局变量 ,触发元素,构造器本身,定义域
  19. 明确真值表 明智的使用真假判断 (a==true)(a)
代码语言:javascript
复制
- logTruthyFalsy(true); // truthy
- logTruthyFalsy(1); // truthy
- logTruthyFalsy({}); // truthy
- logTruthyFalsy([]); // truthy
- logTruthyFalsy('0'); // truthy
- logTruthyFalsy(false); // falsy
- logTruthyFalsy(0); // falsy
- logTruthyFalsy(undefined); // falsy
- logTruthyFalsy(null); // falsy
- logTruthyFalsy(NaN); // falsy
- logTruthyFalsy(''); // falsy

20. 判断是否相等时候 采用=== 判断包括类型的相等 21. 尽量使用语法严格模式 消除代码之中的不友好;代码运行更快 ;保证运行的安全 ;为新版本的js做好铺垫。 22. 匿名函数的调用写在匿名函数的内部

代码语言:javascript
复制
(function(argus){
}(argus))

补充

待补充…

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2016-09-072,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 前言
  • 补充
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档