最近的程序员不谈世界上最好的语言是不是 php,也不谈人生苦短,用不用 python, 研发、测试、运维一片其乐融融,研究的是垃圾分类。
比如小龙虾到底是什么垃圾?
然而祥和的氛围不过三秒,在又看到一行刺眼的“垃圾代码”时,为了避免还要对“垃圾代码”进行分类,我们尝试拯救一下这行代码。
此处小编想说的“垃圾代码”并不是真正的垃圾,而是在质量上有待规范,可以变得质量更高的代码。
JavaScript 风格指南从 10 分方面进行归类,列举通用准则,让你的代码更加规范:
- 介绍
- 变量
- 函数
- 对象和数据结构
- 类
- 测试
- 并发
- 错误处理
- 格式化
- 注释
举个例子:
- 使用有意义,可读性好的变量名
反例:
var yyyymmdstr = moment().format('YYYY/MM/DD');
正例:
var yearMonthDay = moment().format('YYYY/MM/DD');
- 使用 ES6 的 const 定义常量
反例中使用"var"定义的"常量"是可变的。
在声明一个常量时,该常量在整个程序中都应该是不可变的。
反例:
var FIRST_US_PRESIDENT = "George Washington";
正例:
const FIRST_US_PRESIDENT = "George Washington";
- 对功能类似的变量名采用统一的命名风格
反例:
getUserInfo();getClientData();getCustomerRecord();
正例:
getUser();
- 使用易于检索名称
我们需要阅读的代码远比自己写的要多,使代码拥有良好的可读性且易于检索非常重要。阅读变量名晦涩难懂的代码对读者来说是一种相当糟糕的体验。 让你的变量名易于检索。
反例:
// 525600 是什么?for (var i = 0; i < 525600; i++) { runCronJob();}
正例:
// Declare them as capitalized `var` globals.var MINUTES_IN_A_YEAR = 525600;for (var i = 0; i < MINUTES_IN_A_YEAR; i++) { runCronJob();}
GitHub 地址:
英文版:https://github.com/ryanmcdermott/clean-code-javascript
中文版:https://github.com/alivebao/clean-code-js
网站崩溃找不到原因?平台搭建无从下手?热门技术不想落伍?想要变强找不到资料?
[IT拯救联盟],让大牛和同伴拯救你,带你装x带你飞。定期干货分享、大牛专业解答、实用IT工具优选.....
私信小编“联盟”,即可加入我们~