【學習筆記】工程師必備代碼規(guī)范

美觀的代碼在面試、團隊協(xié)同工作、體現(xiàn)個人專業(yè)程度、降低錯誤率等方面都有重要意義。

一、有哪些代碼規(guī)范指南?

一些大廠都出了各自的規(guī)范:
1、Google Style GuideJavaScript 直達戳這)(推薦)
2、Airbnb JavaScript Style Guide(強烈推薦)
3、jQuery JavaScript Style Guide
4、WebKit Code Style Guidelines
5、中文版代碼規(guī)范(騰訊@AlloyTeam)

二、如何提高自己代碼的規(guī)范性?

1、可以選擇以上其中一個作為自己的代碼規(guī)范準則,然后通讀
2、好記性不如爛筆頭,一定要進行實踐
3、關注開源項目中別人的代碼,多逛 Github;
4、學會使用工具幫助自己整理代碼。

三、工具與應用

1、EditorConfig

官網(wǎng)描述:

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

翻譯過來就是:EditorConfig 幫助開發(fā)者們在不同開發(fā)者之間和不同的開發(fā)環(huán)境下保持定義和代碼風格的一致性,抹平不同編輯器的區(qū)別。

EditorConfig 給出如下 JavaScript Code 配置:(具體用法參看:https://github.com/editorconfig/editorconfig-core-js#readme),定義了縮進方式、縮進字符、換行符、編碼方式、多行注釋等規(guī)范。

; 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

如果在你的項目中含有這份配置文件,那么其他所有人在編輯你的項目下共同工作時,提交的代碼都是統(tǒng)一的。

2、ESLint

方法一:Node命令行工具

為了在 Node.js 上運行 ESLint,你必須先安裝 npm。然后執(zhí)行如下命令安裝 ESLint CLI:

npm i -g eslint

檢查代碼時,執(zhí)行如下命令:

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

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內容

友情鏈接更多精彩內容