【学习笔记】工程师必备代码规范

美观的代码在面试、团队协同工作、体现个人专业程度、降低错误率等方面都有重要意义。

一、有哪些代码规范指南?

一些大厂都出了各自的规范:
1、Google Style GuideJavaScript 直达戳这)(推荐)
2、Airbnb JavaScript Style Guide(强烈推荐)
3、jQuery JavaScript Style Guide
4、WebKit Code Style Guidelines
5、中文版代码规范(腾讯@AlloyTeam)

二、如何提高自己代码的规范性?

1、可以选择以上其中一个作为自己的代码规范准则,然后通读
2、好记性不如烂笔头,一定要进行实践
3、关注开源项目中别人的代码,多逛 Github
4、学会使用工具帮助自己整理代码。

三、工具与应用

1、EditorConfig

官网描述:

EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs.

翻译过来就是:EditorConfig 帮助开发者们在不同开发者之间和不同的开发环境下保持定义和代码风格的一致性,抹平不同编辑器的区别。

EditorConfig 给出如下 JavaScript Code 配置:(具体用法参看:https://github.com/editorconfig/editorconfig-core-js#readme),定义了缩进方式、缩进字符、换行符、编码方式、多行注释等规范。

; http://editorconfig.org

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
block_comment_start = /**
block_comment = *
block_comment_end = */

[*.md]
indent_size = 4

如果在你的项目中含有这份配置文件,那么其他所有人在编辑你的项目下共同工作时,提交的代码都是统一的。

2、ESLint

方法一:Node命令行工具

为了在 Node.js 上运行 ESLint,你必须先安装 npm。然后执行如下命令安装 ESLint CLI:

npm i -g eslint

检查代码时,执行如下命令:

eslint file1.js file2.js

举个栗子:
在编辑器中敲入 var x = 1; 这行代码,保存成 test.js 。然后进入 test.js 文件所在目录下,使用命令行输入 eslint test.js,得到如下结果:

敲入 eslint 命令后返回的结果

上图中提示了 var x = 1; 这行代码有 2 个错误:

  • 不推荐使用 var,请使用 let 或 const 代替。
  • x 是一个从未使用的变量,建议删除。

方法二:配置文件

在你的项目中放入并修改 .eslintrc.js 文件进行配置(下载和用法戳这:https://github.com/eslint/eslint)。

方法三:编辑器插件

在编辑器中安装 ESLint 插件,就能在编辑器中看到提示,如下:


VS Vode 中的提示

四、另外一些好用的编辑器插件

1、EditorConfig for VS Code
2、Git Blame
3、Project Manager
4、.ejs
5、Document this

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,372评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,368评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,415评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,157评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,171评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,125评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,028评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,887评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,310评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,533评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,690评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,411评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,004评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,812评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,693评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,577评论 2 353

推荐阅读更多精彩内容