当前流行的JavaScript代码风格指南(2)
开始的第一个单词小写,之后的所有单词首字母大写:Google、NPM、Node.js、Idiomatic
var foo = “”;
var fooName = “”;
2.2 常量命名
使用大写字母:Google、NPM、Node.js
没有发表意见:jQuery、Idiomatic、Crockford
2.3 函数命名
开始的第一个单词小写,之后的所有单词首字母大写(驼峰式):Google、NPM、Idiomatic、Node.js(推荐使用长的、具描述性的函数名)
function veryLongOperationName
function short()..
关键字形式的函数命名:
function isReady()
function setName()
function getName()
没有发表意见:jQuery、Crockford
2.4 数组命名
使用复数形式:Idiomatic
没有发表意见:Google、jQuery、NPM、Node.js、Crockford
2.5 对象和类命名
使用如下形式:Google、NPM、Node.js
var ThisIsObject = new Date;
没有发表意见:jQuery、Idiomatic、Crockford
2.6 其他命名
针对长文件名和配置键使用all-lower-hyphen-css-case形式:NPM
3. 根据上述风格配置 .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 将会运行得更快。
4. 在提交 Git 之前自动执行 JSHint