一些达成共识的JavaScript编码风格约定
如果你的代码易于阅读,那么代码中bug也将会很少,因为一些bug可以很容被调试,并且,其他开发者参与你项目时的门槛也会比较低。因此,如果项目中有多人参与,采取一个有共识的编码风格约定非常有必要。与其他一些语言相比(比如Python示例),JavaScript没有一个权威的编码风格指南,取而代之的是一些流行的编码风格:
- Google的JavaScript风格指南(以下简称Google)
- NPM编码风格(以下简称NPM)
- Felix的Node.js风格指南(以下简称Node.js)
- 惯用(Idiomatic)的JavaScript(以下简称Idiomatic)
- jQuery JavaScript风格指南(以下简称jQuery)
- Douglas Crockford的JavaScript风格指南(以下简称Crockford),Douglas Crockford是Web开发领域最知名的技术权威之一,ECMA JavaScript 2.0标准化委员会委员
当然,在JavaScript语法检查器JSLint和JSHint中也有一些默认的设置选择。问题是,什么才是终极的、让大多数开发者可以遵循的JavaScript编码风格呢?下面让我们从这6个风格指南中找出一些有共识的风格来。
代码风格
缩进
- 两个空格,无需更长的缩进,无需Tab缩进:Google、NPM、Node.js、Idiomatic
- Tab缩进:jQuery
- 4个空格:Crockford
参数和表达式之间的空格
- 使用紧凑型风格:Google、NPM、Node.js
Js代码
project.MyClass = function(arg1, arg2) {
- 过多地使用空格:Idiomatic, jQuery
Js代码
for ( i = 0; i < length; i++ ) {
- 没有发表意见:Crockford
大部分指南中,都提醒开发者不要在语句结尾处有任何的空格。
代码行长度
- 最多80个字符:Google、NPM、Node.js、Crockford(当在代码块中,除了2个空格外的其他缩进允许将函数参数与首个函数参数的位置对齐。另一种选择是当自动换行时使用4个空格缩进,而不是2个。)
- 没有发表意见:jQuery、Idiomatic
分号
- 始终使用分号,不依赖于隐式插入:Google、Node.js、Crockford
- 在某些情况下不要使用expect:NPM
- 没有发表意见:jQuery、Idiomatic
注释
- 遵循JSDoc约定:Google、Idiomatic
- 没有发表意见:NPM、Node.js、jQuery、Crockford
引号
- 推荐单引号:Google、Node.js
- 双引号:jQuery
- 没有发表意见:NPM、Idiomatic、Crockford
变量声明
- 一次声明一个,不使用逗号:Node.js
Js代码
var foo = '';
var bar = '';
- 一次声明多个,在行结束处使用逗号分隔:Idiomatic、jQuery
Js代码
var foo = "",
bar = "",
quux;
- 在行开始处使用逗号:NPM
- 没有发表意见:Google、Crockford
大括号
- 在同一行使用左大括号:Google、NPM、Node.js、Idiomatic、 jQuery、Crockford
Js代码
function thisIsBlock(){
NPM指南中指出,只在代码块需要包含下一行时使用大括号,否则不使用。
全局变量
- 不要使用全局变量:Google、Crockford(谷歌表示,全局变量命名冲突难以调试,并可能在两个项目进行正整合时出现一些棘手的问题。为了便于共享公用的JavaScript代码,需要制定公约来避免冲突发生。Crockford认为不应该使用隐式全局变量。)
- 没有发表意见:Idiomatic、jQuery、NPM、Node.js
命名风格
变量命名
- 开始的第一个单词小写,之后的所有单词首字母大写:Google、NPM、Node.js、Idiomatic
Js代码
<blockquote>var foo = "";
常量命名
- 使用大写字母:Google、NPM、Node.js
Js代码
var CONS = 'VALUE';
- 没有发表意见:jQuery、Idiomatic、Crockford
函数命名
- 开始的第一个单词小写,之后的所有单词首字母大写(驼峰式):Google、NPM、Idiomatic、Node.js(推荐使用长的、具描述性的函数名)
Js代码
function veryLongOperationName
function short()..
关键字形式的函数命名:
Js代码
function isReady()
function setName()
function getName()
- 没有发表意见:jQuery、Crockford
阵列命名
- 使用复数形式:Idiomatic
Js代码
var documents = [];
- 没有发表意见:Google、jQuery、NPM、Node.js、Crockford
对象和类命名
- 使用如下形式:Google、NPM、Node.js
Js代码
var ThisIsObject = new Date;
- 没有发表意见:jQuery、Idiomatic、Crockford
其他命名
- 针对长文件名和配置键使用all-lower-hyphen-css-case形式:NPM
根据上述风格来配置.jshintrc文件
JSHint(http://www.jshint.com/)是一个JavaScript语法和风格检查工具,你可以用它来提醒代码风格相关的问题。它可以很好地被集成到许多常用的编辑器中,是统一团队编码风格的一个很好的工具。
你可以通过JSHint文档查看可用的选项:http://www.jshint.com/docs/#options
下面根据本文上面每个分类下的第一种风格来创建一个.jshintrc文件。你可以将它放到项目中根目录中,JSHint-avare代码编辑器将会按照它来统一项目中的所有代码风格。
Js代码
{
"camelcase" : true,
"indent": 2,
"undef": true,
"quotmark": single,
"maxlen": 80,
"trailing": true,
"curly": true
}
此外,你应该将下面的头添加到你的JavaScript文件中。
Js代码
/*jshint node:true */
还可以在各种JavaScript文件中添加下面的声明:
Js代码
'use strict';
这将影响JSHint和你的JavaScript引擎,可能不那么兼容,但是JavaScript将会运行得更快。
在提交Git之前自动执行JSHint
如果你想确保所有的JS代码与.jshintrc中定义的风格保持一致,你可以将下面的内容添加到你的.git/hooks/pre-commit文件中,当你试图提交任何新修改的文件到项目时会自动执行风格检查。
Js代码
#!/bin/bash
# Pre-commit Git hook to run JSHint on JavaScript files.
#
# If you absolutely must commit without testing,
# use: git commit --no-verify filenames=($(git diff --cached --name-only HEAD)) which jshint &> /dev/null
if [ $? -ne 0 ];
then
echo "error: jshint not found"
echo "install with: sudo npm install -g jshint"
exit 1
fi for i in "${filenames[@]}"
do
if [[ $i =~ \.js$ ]];
then
echo jshint $i
jshint $i
if [ $? -ne 0 ];
then
exit 1
fi
fi
done
一些达成共识的JavaScript编码风格约定的更多相关文章
- 一些达成共识的JavaScript编码风格约定【转】
如果你的代码易于阅读,那么代码中bug也将会很少,因为一些bug可以很容被调试,并且,其他开发者参与你项目时的门槛也会比较低.因此,如果项目中有多人参与,采取一个有共识的编码风格约定非常有必要.与其他 ...
- 一些达成共识的JavaScript编码约定[转]
如果你的代码易于阅读,那么代码中bug也将会很少,因为一些bug可以很容被调试,并且,其他开发者参与你项目时的门槛也会比较低.因此,如果项目中有多人参与,采取一个有共识的编码风格约定非常有必要.与其他 ...
- JavaScript编码风格指南(中文版)
前言: 程序语言的编码风格对于一个长期维护的软件非常重要,特别是在团队协作中.如果一个团队使用统一规范的编码分风格,可以提高团队的协作水平和工作效率.编程风格指南的核心是基本的格式化规则,这些规则决定 ...
- 良好的JavaScript编码风格(语法规则)
编码风格 1.概述 "编程风格"(programming style)指的是编写代码的样式规则.不同的程序员,往往有不同的编程风格. 有人说,编译器的规范叫做"语法规则& ...
- JavaScript编码风格
最近在看前端大牛Nicbolas C.Zakas的<编写可维护的JavaScript代码>一书.觉得里面的很多知识点都写的很好,所以,就写篇博文,总结一下吧!编码规范对于程序设计来说是很重 ...
- 【荐】JavaScript编码风格
作者:阮一峰 Douglas Crockford是 JavaScript 权威,Json 格式就是他的发明. 去年 11 月他有一个演讲(Youtube),谈到了好的 JavaScript 编程风格是 ...
- 《编写可维护的 Javascript》读书笔记(附录 A 部分):Javascript 编码风格指南(1)原始值
记录一下比较有用的编码规范(该指南是基于 Java 语言编码规范和 Javascript 编程规范,同时结合作者 Nicholos Zakas 的个人经验和喜好). 一些关于格式(包括缩进.行的长度. ...
- Airbnb JavaScript 编码风格指南(2018年最新版)
原网址 : https://segmentfault.com/a/1190000013040555 类型 基本类型:直接存取 string number boolean null undefined ...
- JavaScript 编码风格指南
A.1 缩进 // 4个空格的层级缩进 if (true) { doSomething(); } A.2 行的长度 // 每行限于80个字符,超出则在运算符后换行,缩进2个层级(8个空格) doS ...
随机推荐
- STL 案例分析
#include <iostream> using namespace std; #include "string" #include <vector> # ...
- Android+Robotium
因为调动到一个新的部门在这个部门做的一直就是移动产品,所以这段时间会一直不断的研究app的自动化,主要是针对android,这里我采用的是Robotium框架,这个框架比较简单,使用eclipse+r ...
- 安装DirectX SDK时出现Error Code:s1023 的解决方案
刚刚安装DXSDK_Jun10时(下载地址:http://download.microsoft.com/download/A/E/7/AE743F1F-632B-4809-87A9-AA1BB3458 ...
- argparse - 命令行选项与参数解析(转)
argparse - 命令行选项与参数解析(译)Mar 30, 2013 原文:argparse – Command line option and argument parsing 译者:young ...
- Android(java)学习笔记95:Android原理揭秘系列之View、ViewGroup
作过Android 应用开发的朋友都知道,Android的UI界面都是由View和ViewGroup及其派生类组合而成的.其中,View是所有UI组件的基类,而ViewGroup是容纳这些组件的容器, ...
- vim 编辑器 打开GB2312、GBK文件乱码解决方法
安装好的操作系统一般都带有vim编辑器,但是默认不支持GB2312中文,打开文件出现乱码,解决办法如下. 1.打开以下文件 sudo vim /var/lib/locales/supported.d/ ...
- [改善Java代码]适时选择getDeclaredxxx和getxxx
Java的Class类提供了很多的getDeclaredxxx方法和getxxx方法,例如getDeclaredmethod和getMethod成对出现,getDeclaredConstructors ...
- Netty学习链接
Netty实战精髓请参见:https://waylau.gitbooks.io/essential-netty-in-action/content/GETTING%20STARTED/Introduc ...
- 在windows2003系统上安装两个版本的oracle
想试试oracle11g都有什么变化,于是在机器上又安装了oracle11.1.7版本的.安装很简单,只是安装后如何让两个数据库同时跑起来,需要稍微设置下.1.将11goracle的监听换一个端口,比 ...
- SQL Server 2005中约束
在SQL Server 2005中有6种约束:主键约束(primary key constraint).惟一性约束(unique constraint).检查约束(check constraint). ...