一些达成共识的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
project.MyClass = function(arg1, arg2) {
- 过多地使用空格:Idiomatic, jQuery
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
var foo = '';
var bar = '';
- 一次声明多个,在行结束处使用逗号分隔:Idiomatic、jQuery
var foo = "",
bar = "",
quux;
- 在行开始处使用逗号:NPM
- 没有发表意见:Google、Crockford
大括号
- 在同一行使用左大括号:Google、NPM、Node.js、Idiomatic、 jQuery、Crockford
function thisIsBlock(){
NPM指南中指出,只在代码块需要包含下一行时使用大括号,否则不使用。
全局变量
- 不要使用全局变量:Google、Crockford(谷歌表示,全局变量命名冲突难以调试,并可能在两个项目进行正整合时出现一些棘手的问题。为了便于共享公用的JavaScript代码,需要制定公约来避免冲突发生。Crockford认为不应该使用隐式全局变量。)
- 没有发表意见:Idiomatic、jQuery、NPM、Node.js
命名风格
变量命名
- 开始的第一个单词小写,之后的所有单词首字母大写:Google、NPM、Node.js、Idiomatic
var foo = "";
var fooName = "";
常量命名
- 使用大写字母:Google、NPM、Node.js
var CONS = 'VALUE';
- 没有发表意见:jQuery、Idiomatic、Crockford
函数命名
- 开始的第一个单词小写,之后的所有单词首字母大写(驼峰式):Google、NPM、Idiomatic、Node.js(推荐使用长的、具描述性的函数名)
function veryLongOperationName
function short()..
关键字形式的函数命名:
function isReady()
function setName()
function getName()
- 没有发表意见:jQuery、Crockford
阵列命名
- 使用复数形式:Idiomatic
var documents = [];
- 没有发表意见:Google、jQuery、NPM、Node.js、Crockford
对象和类命名
- 使用如下形式:Google、NPM、Node.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代码编辑器将会按照它来统一项目中的所有代码风格。
{
"camelcase" : true,
"indent": 2,
"undef": true,
"quotmark": single,
"maxlen": 80,
"trailing": true,
"curly": true
}
此外,你应该将下面的头添加到你的JavaScript文件中。
/* jshint browser:true, jquery:true */
在Node.js文件中你应该添加:
/*jshint node:true */
还可以在各种JavaScript文件中添加下面的声明:
'use strict';
这将影响JSHint和你的JavaScript引擎,可能不那么兼容,但是JavaScript将会运行得更快。
在提交Git之前自动执行JSHint
如果你想确保所有的JS代码与.jshintrc中定义的风格保持一致,你可以将下面的内容添加到你的.git/hooks/pre-commit文件中,当你试图提交任何新修改的文件到项目时会自动执行风格检查。
#!/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
最后祝大家编码愉快!
原文发布时间为:2013-07-12
本文来自云栖社区合作伙伴“Linux中国”
一些达成共识的JavaScript编码风格约定相关推荐
- JavaScript编码风格指南
首次发表在个人博客 前言 程序语言的编码风格指南对于一个长期维护的软件而言是非常重要的;好的编程风格有助于写出质量更高.错误更少.更易于 维护的程序. 团队合作需要制定一些代码规范还有利用一些工具来强 ...
- Airbnb JavaScript 编码风格指南(2018年最新版)
Airbnb JavaScript 编码风格指南(2018年最新版) 访问此原文地址:http://galaxyteam.pub/didi-fe... 另外欢迎访问我们维护的https://www.t ...
- 良好的JavaScript编码风格(语法规则)
编码风格 1.概述 "编程风格"(programming style)指的是编写代码的样式规则.不同的程序员,往往有不同的编程风格. 有人说,编译器的规范叫做"语法规则& ...
- 淘宝JavaScript 编码风格规范
行与缩进 语句行 尽可能不要让每行超过 120 个字符; 语句必须以分号作为结束符, 不要忽略分号; 空格 数值操作符(如, +/-/*/% 等)两边留空; 赋值操作符/等价判断符两边留一空格; fo ...
- javascript编程风格(粗略笔记)
1.空格 紧凑型: project.MyClass = function(arg1, arg2){ 松散型: for( i = 0; i < length; i++ ){ 2.代码行长度 最多8 ...
- JavaScript => JavaScript编码规范指南
JavaScript 编码规范指南 以下文档大多来自: Google JavaScript 编码规范指南 Idiomatic 风格 对于未提及的事项可以参考airbnb的JS编码规范 airbnb/j ...
- 来自 Google 的 R 语言编码风格指南
来自 Google 的 R 语言编码风格指南 R 语言是一门主要用于统计计算和绘图的高级编程语言. 这份 R 语言编码风格指南旨在让我们的 R 代码更容易阅读.分享和检查. 以下规则系与 Google ...
- JavaScript编码规范[百度]
JavaScript编码规范 1 前言 2 代码风格 2.1 文件 2.2 结构 2.2.1 缩进 2.2.2 空格 2.2.3 换行 2.2.4 语句 2.3 命名 2.4 注释 2.4.1 单行注 ...
- Javascript编码规范,好的代码从书写规范开始,增强代码的可读性,可维护性,这是相当重要的!...
1. 前言 JavaScript在百度一直有着广泛的应用,特别是在浏览器端的行为管理.本文档的目标是使JavaScript代码风格保持一致,容易被理解和被维护. 虽然本文档是针对JavaScript设 ...
最新文章
- Office 365管理员指引 9 ——Lync 自定义会议邀请
- java编写提升性能的代码
- History of program (language).
- 中国科学院计算机专业职称,2018年春季工程技术系列专业技术资格职称评审结束...
- 从零点五开始用Unity做半个2D战棋小游戏(四)
- 前端 --- 关于DOM的介绍
- windows驱动程序编写_如何在Windows中回滚驱动程序
- 了解Spring Web初始化
- C语言 十进制和十六进制相互转换 - C语言零基础入门教程
- AptitudeSystem 2.0
- 开源许可协议,开源许可证GPL、BSD、MIT、Mozilla、Apache和LGPL的区别
- PCM data flow - 1 - Overview
- Android Audio打开输出设备流程(十五)
- 再也不怕重装eclipse! 让你的eclipse插件只下载一次
- 《深度学习Python实践》附录——决策树模型可视化
- 使用go语言开发一个后端gin框架的web项目
- c语言指针经典例,C语言指针应用简单实例
- 【手册】Linux User's Manual
- 股票自动交易软件的特点?
- Codeforces 863B Kayaking 暴力 水题