0

0

当前流行的JavaScript代码风格指南_javascript技巧

php中文网

php中文网

发布时间:2016-05-16 16:36:39

|

1566人浏览过

|

来源于php中文网

原创

JavaScript 没有一个权威的编码风格指南,取而代之的是一些流行的编码风格:

复制代码 代码如下:

Google的JavaScript风格指南(以下简称Google)
http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
NPM编码风格(以下简称NPM)
https://npmjs.org/doc/coding-style.html
Felix的Node.js风格指南(以下简称Node.js)
http://nodeguide.com/style.html
惯用(Idiomatic)的JavaScript(以下简称Idiomatic)
https://github.com/rwldrn/idiomatic.js/
jQuery JavaScript风格指南(以下简称jQuery)
http://contribute.jquery.org/style-guide/js/
Douglas Crockford的JavaScript风格指南(以下简称Crockford),Douglas Crockford是Web开发领域最知名的技术权威之一,ECMA JavaScript 2.0标准化委员会委员
http://javascript.crockford.com/code.html

当然,在JavaScript语法检查器 JSLint 和 JSHint 中也有一些默认的设置选择。问题是,什么才是终极的、让大多数开发者可以遵循的JavaScript编码风格呢?下面让我们从这6个风格指南中找出一些有共识的风格来。

1. 代码风格比较

1.1 缩进

两个空格,无需更长的缩进,无需Tab缩进:Google、NPM、Node.js、Idiomatic
Tab缩进:jQuery
4个空格:Crockford

1.2 参数和表达式之间的空格

使用紧凑型风格:Google、NPM、Node.js

复制代码 代码如下:
project.MyClass = function(arg1, arg2) {

过多地使用空格:Idiomatic, jQuery
复制代码 代码如下:
for ( i = 0; i
没有发表意见:Crockford
大部分指南中,都提醒开发者不要在语句结尾处有任何的空格。

1.3 代码行长度

最多80个字符:Google、NPM、Node.js、Crockford(当在代码块中,除了2个空格外的其他缩进允许将函数参数与首个函数参数的位置对齐。另一种选择是当自动换行时使用4个空格缩进,而不是2个。)
没有发表意见:jQuery、Idiomatic

1.4 分号

立即学习Java免费学习笔记(深入)”;

始终使用分号,不依赖于隐式插入:Google、Node.js、Crockford
在某些情况下不要使用expect:NPM
没有发表意见:jQuery、Idiomatic

1.5 注释

遵循JSDoc约定:Google、Idiomatic
没有发表意见:NPM、Node.js、jQuery、Crockford

1.6 引号

推荐单引号:Google、Node.js
双引号:jQuery
没有发表意见:NPM、Idiomatic、Crockford

1.7 变量声明

一次声明一个,不使用逗号:Node.js

复制代码 代码如下:

var foo = ”;
var bar = ”;

一次声明多个,在行结束处使用逗号分隔:Idiomatic、jQuery
复制代码 代码如下:

var foo = “”,
bar = “”,
quux;

在行开始处使用逗号:NPM
没有发表意见:Google、Crockford

1.8 大括号

在同一行使用左大括号:Google、NPM、Node.js、Idiomatic、 jQuery、Crockford

复制代码 代码如下:
function thisIsBlock(){

NPM指南中指出,只在代码块需要包含下一行时使用大括号,否则不使用。

1.9 全局变量

不要使用全局变量:Google、Crockford(谷歌表示,全局变量命名冲突难以调试,并可能在两个项目进行正整合时出现一些棘手的问题。为了便于共享公用的JavaScript代码,需要制定公约来避免冲突发生。Crockford认为不应该使用隐式全局变量。)

没有发表意见:Idiomatic、jQuery、NPM、Node.js

2 命名风格

2.1 变量命名

开始的第一个单词小写,之后的所有单词首字母大写:Google、NPM、Node.js、Idiomatic

Flowith
Flowith

一款GPT4驱动的节点式 AI 创作工具

下载
复制代码 代码如下:

var foo = “”;
var fooName = “”;

2.2 常量命名

使用大写字母:Google、NPM、Node.js

复制代码 代码如下:
var CONS = ‘VALUE';

没有发表意见: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

复制代码 代码如下:
var documents = [];

没有发表意见: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

如果你想确保所有的 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



相关文章

java速学教程(入门到精通)
java速学教程(入门到精通)

java怎么学习?java怎么入门?java在哪学?java怎么学才快?不用担心,这里为大家提供了java速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Golang处理数据库错误教程合集
Golang处理数据库错误教程合集

本专题整合了Golang数据库错误处理方法、技巧、管理策略相关内容,阅读专题下面的文章了解更多详细内容。

67

2026.02.06

java多线程方法汇总
java多线程方法汇总

本专题整合了java多线程面试题、实现函数、执行并发相关内容,阅读专题下面的文章了解更多详细内容。

32

2026.02.06

1688阿里巴巴货源平台入口与批发采购指南
1688阿里巴巴货源平台入口与批发采购指南

本专题整理了1688阿里巴巴批发进货平台的最新入口地址与在线采购指南,帮助用户快速找到官方网站入口,了解如何进行批发采购、货源选择以及厂家直销等功能,提升采购效率与平台使用体验。

489

2026.02.06

快手网页版入口与电脑端使用指南 快手官方短视频观看入口
快手网页版入口与电脑端使用指南 快手官方短视频观看入口

本专题汇总了快手网页版的最新入口地址和电脑版使用方法,详细提供快手官网直接访问链接、网页端操作教程,以及如何无需下载安装直接观看短视频的方式,帮助用户轻松浏览和观看快手短视频内容。

265

2026.02.06

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

18

2026.02.06

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

29

2026.02.06

JavaScript 异步编程与事件驱动架构
JavaScript 异步编程与事件驱动架构

本专题深入讲解 JavaScript 异步编程与事件驱动架构,涵盖 Promise、async/await、事件循环机制、回调函数、任务队列与微任务队列、以及如何设计高效的异步应用架构。通过多个实际示例,帮助开发者掌握 如何处理复杂异步操作,并利用事件驱动设计模式构建高效、响应式应用。

14

2026.02.06

java连接字符串方法汇总
java连接字符串方法汇总

本专题整合了java连接字符串教程合集,阅读专题下面的文章了解更多详细操作。

69

2026.02.05

java中fail含义
java中fail含义

本专题整合了java中fail的含义、作用相关内容,阅读专题下面的文章了解更多详细内容。

32

2026.02.05

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 4.8万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.8万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号