JavaScript 代码风格指南
一.基本格式
缩进
建议每级4个空格,可以给编辑器设置tab = 4个空格,自动转换
分号
不要省略分号,防止ASI(自动插入分号)错误
行宽
每行代码不超过80个字符,过长应该用操作符手动断行
断行
操作符在上一行末尾,且下一行缩进2级,如果是赋值语句,还应该和等号后面部分对齐
空行
函数声明与函数声明、变量声明与函数声明、函数内部的逻辑块之间都应该有空行隔开
作者尼古拉斯还建议在流程控制块顶部留一个空行,但给的例子不是很明确
命名
- 变量名/函数名:Camel(驼峰)规则,首词首字母小写,后续词首字母大写,其余部分小写
- 常量名:C语言式,全大写,下划线分词
- 构造函数:Pascal规则,所有词首字母大写,其余部分小写
字面量
- 字符串:双引号包裹,断行用[+]操作符,不要用\转义字符
- 数值:不要省略小数点前后的部分,不要用八进制形式
- Null:只把null当作Object的占位符,不要用来检测形参,也不要用来检测未初始化的变量
- Undefined:应该把所有对象都初始化为null,以区分未定义和未初始化
- 对象字面量/数组字面量:不要用构造函数方式声明对象和数组
二.注释
P.S.书中有一句非常经典的解释:
Appropriately written comments help tell the story of code, allowing other developers to drop into a part of the story without needing to hear the beginning.
单行注释
- 行尾:用1级缩进隔开代码,而且//后面要有一个空格
- 独占一行:用来注释下面,要与被注释的代码保持相同的缩进
- 行首:用来注释多行代码
多行注释
用来包裹大段注释,推荐Eclipse风格,例如
/*
* comment line1
* comment line2
*/
注意:
- 多行注释上方留一个空行
- *星号后面留一个空格
- 多行注释至少三行(因为第一行和最后一行后面不加注释)
在哪里添注释
- 不能自解释的代码
- 故意的,但看起来像是有错的地方
- 针对浏览器的hack
文档注释
应该给各个函数添注释,包括功能描述、参数、返回值、抛出的错误等等,例如推荐的Eclipse风格:
/**
* 添加指定元素到默认数组
*
* @method add
* @param {Number} 将要添加的元素
* @return {Boolean} 添加成功/失败
* @throw {TypeError} 参数类型不匹配
*/
function add(item){
if(typeof item === "number"){
arr.push(item)
}
else{
throw new TypeError();
}
}
三.语句和表达式
花括号对齐方式
建议行尾风格,不推荐次行风格
块语句空格
if后的圆括号部分前后各有一个空格,例如:
if (expr) {
code
}
switch语句
- 缩进:case与switch对齐,break缩进1级
- case贯穿:用空行或注释//falls through表明case贯穿是故意的
- default:保留default或者用注释//no default表明没有default
P.S.《JavaScript语言精粹》的作者道格拉斯认为不应该用case贯穿(称之为鸡肋),因为极易引发bug,而尼古拉斯认为用空行或者注释说明就好了
with语句
不用
for循环
所有变量都应该在函数体顶部声明,包括for循环初始化部分用到的变量,避免hosting(提升)引发bug(可能会屏蔽全局变量)
for-in循环
不要用来遍历数组,用的时候记得加上hasOwnProperty过滤,如果故意遍历原型属性,应该用注释说明
四.变量、函数、操作符
变量声明
函数体 = 变量声明 + 函数声明 + 逻辑语句。用空行隔开各个部分
函数声明
先声明再使用,千万不要把函数声明放在if分支里,因为浏览器理解不同,而且ES没给标准
函数调用
圆括号前后都不加空格,避免和块语句混淆
匿名函数立即执行
把立即执行的匿名函数用圆括号包裹,避免与匿名函数声明混淆
严格模式
不要在全局作用域开严格模式,只在函数内部开,给多个函数开可以用匿名函数立即执行限定严格模式的作用域
判断等于
只用===和!==
eval
不用eval()和new Function(),用匿名函数优化setTimeout()和setInterval()
基本包装类型
不要用new Boolean(), new String(), new Number()
JavaScript 代码风格指南的更多相关文章
- Google JavaScript代码风格指南
Google JavaScript代码风格指南 修正版本 2.28 Aaron Whyte Bob Jervis Dan Pupius Eric Arvidsson Fritz Schneider R ...
- 《Google 代码风格指南》
<Google 代码风格指南> https://github.com/google/styleguide
- python的PEP8 代码风格指南
PEP8 代码风格指南 这篇文章原文实际上来自于这里:https://www.python.org/dev/peps/pep-0008/ 知识点 代码排版 字符串引号 表达式和语句中的空格 注释 版本 ...
- C++代码风格指南总结
C++代码风格指南 代码风格的重要性 今天我收到thougthwork笔试没过的消息, 心里确实很难受, 然后师兄说我代码写得很糟糕 细想一下, 我写代码确实是随心所欲, 并没有遵循什么规范; 所以现 ...
- 大神的JS代码风格指南
js代码风格指南:1.缩进使用空格,不要用制表符2.必须用分号3.暂时不用ES6(modules)例如export和import命令4.不鼓励(不禁止)水平对齐5.少用var 都应该使用const或者 ...
- 读 Angular 代码风格指南
读 Angular 代码风格指南 本文写于 2021 年 1 月 17 日 原文地址:Angular 文档 该文章拥有完整的代码风格指南--大到如何编排文件夹,小到如何进行变量命名都涉及.但是与 ng ...
- JavaScript编码风格指南(中文版)
前言: 程序语言的编码风格对于一个长期维护的软件非常重要,特别是在团队协作中.如果一个团队使用统一规范的编码分风格,可以提高团队的协作水平和工作效率.编程风格指南的核心是基本的格式化规则,这些规则决定 ...
- Google代码风格指南
官网:https://github.com/google/styleguide 中文版:https://github.com/zh-google-styleguide/zh-google-styleg ...
- Google HTML/CSS代码风格指南(中文版)
原文链接:http://wncbl.cn/posts/c8e10815/ 看一下没什么印象,那就写一遍吧. 背景 本文档定义了HTML/CSS的编写格式和风格规则.它旨在提高合作和代码质量,并使其支持 ...
随机推荐
- http协议进阶(二)URL与资源
一.URL的语法 URL是互联网资源的标准化名称 URL提供了一种定位互联网上任意资源的手段,但这些资源要通过不同方案(协议:比如http.ftp.smtp)来访问,因此URL语法会略有差异 大部分 ...
- php配置参数.md
php 5.5 配置文件 php.ini Options user_ini.filename string 设定了 PHP 会在每个目录下搜寻的文件名:如果设定为空字符串则 PHP 不会搜寻.默认值是 ...
- NSBundle
属性: .使用类方法创建一个NSBundler对象 + (NSBundle *)mainBundle; eg:[NSBundle mailBundle]; .使用路径获取一个NSBundle 对象,这 ...
- Revolving Digits[EXKMP]
Revolving Digits Time Limit: 3000/1000 MS (Java/Others) Memory Limit: 65536/32768 K (Java/Others) ...
- 使用 VS Code 来编辑 markdown 文章
一开始我就用 VS Code 来编辑 markdown 文本,只是因为 VS Code 用起来感觉很好,然后我又去寻找其他的能够预览 markdown 的编辑器,看了好多都不是很方便.突然我发现 VS ...
- python select 实现
python的select()方法直接调用操作系统的IO接口 它监控sockets,openfiile,pipes (所有带fileno()的方法的文件句柄) 什么时候变成 readable writ ...
- 解决:error: .repo/manifests/: contains uncommitted changes
repo sync同步时提示出错: error: .repo/manifests/: contains uncommitted changes 解决方法: 1.cd 进入.repo/ ...
- ReactNative 从环境和第一个demo说起,填坑教程
一.React-Native MacOS必备环境配置: 1.安装homebrew(这东西可以理解为命令行的app商店) /usr/bin/ruby -e "$(curl -fsSL http ...
- Hibernate的关联映射关系
一:多对一 <many-to-one 1.name:当前类的属性名(关联映射的类) 2.column:属性多对应的类的对应的表的外键(连接条件) 3.class:属性所对应的类的权限定名 4.n ...
- BZOJ2728: [HNOI2012]与非
线性基乱搞,非正解= = #include<cstdio> int n,m; typedef long long ll; ll l[60],j,s,t; void up(ll& i ...