JavaScript 变量命名

更新日期: 2021-06-24阅读: 1.7k标签: 变量
计算机科学中只有两个难题:缓存失效和命名。—— Phil Karlton
任何人都能写出计算机能够理解的代码,只有好程序员才能写出人能够理解的代码。—— Martin Flower

好的代码读起来如同在读一段文章

function startEditing() {
  if (user.canEdit(currentDocument)) {
    editorControl.setEditMode(true);
    setButtonDown(btnStartEditing);
  }
}

"牛逼"的代码五花八门,这里来段非常牛逼的大家感受下:

const john = new Lady('lily'); 
console.log(john.name); // 当看到控制台输出 "rose" 你是什么感受?

再看一个变量名逐步迭代的过程:

// bad
const fruit = ['apple', 'banana'];

// ok
const fruitArr = ['apple', 'banana'];

// good
const fruits = ['apple', 'banana'];

// great
const fruitNames = ['apple', 'banana'];

const fruits = [
  { name: 'apple', color: 'red' },
  { name: 'banana', color: 'yellow' },
];

看完以上几个示例,我们就知道自己在变量命名这么一件简单的事情上达到了什么层次。当然,其实这个”小事“并不简单,且很重要。本文从「符合命名规范」和「有意义的命名」两个维度,提出了一些实操建议,欢迎拍砖。


符合规范的命名 Comply with naming conventions

用小驼峰形式命名 Use (lower) camelCase

第一个字母小写,剩下的每个单词的首字母大写。

常量可以采用全大写的形式,但普通的 const 修饰的变量不应该大写 Capitalize constant values (if you want)

const HOURS_IN_DAY = 24;
const USER_AGE = 30;

// bad 下面这些并不是常量,只是不会被修改的变量
const USER = findUser();
const TODAY = new Date();

另外附带说明下,代码里应该避免使用魔法数字。

两个字母的缩略词都大写,大于两个则改驼峰 Capitalize two-letter acronyms

IO
AppID

// bad
Io
APPID

下划线是有特定意义的,不要乱用 Avoid underscores in your names

this._myPrivateMethod = function () { /* ... */ };

// bad
const _someGlobalVar = 1;


有意义的命名 Be expressive

Most of these conventions are not for you today, but instead, for you and the people reading your code tomorrow.

使用具描述性的名字 Use meaningful names

这一条包含的信息比较宽泛,这里稍微再展开下:

命名要精确表意,不能太宽泛,更不能词不达意
    同一个事物可能有多个单词适配,选最合适的
    同一个词有多种含义
使用业务术语。应避免从电脑的视角去命名,而是应该从人类认识事物的角度去命名
尽量避免用缩略语
避免使用黑话。我知道你是业内大佬,但我是小菜菜
单词拼拼对。推荐安装「Code Spell Checker」或其他类似插件

getUserPosts

// bad 含义过于宽泛,不精确
getUserData
getUserInfo

// bad 不要用单个单词的变量,如果只是很小的范围内使用的临时变量则无大碍
global.d = new Date()

用词应尽量精简,无法精简长些也无妨,不能为了精简而放弃语义 When in doubt, favor descriptive over concise

findUserByNameOrEmail
setUserLoggedInTrue

// bad 选词应该尽量精简,但必须保证语义的确定性
findUser
getUserFriend

// bad "FromDatabase" 提供了多少附加信息? 这种可以精简掉
getUserFriendFromDatabase

在上下文中保证意义明确 Be meaningful within their context

这一条可以认为是上面两条的结合,命名不应该重复上下文信息

Class Employee {
  constructor (name) {
    // good
    this.name = name;
    // bad 因为本身就处在 Employee 这个上下文中,信息冗余
    this.employeeName = name;
  }
}

// 这里在 name 前加 employee 是有必要的,因为已经脱离了 Employee 这个上下文
const employeeName = new Employee('gavin').name;

保证动词的统一性 Use consistent verbs per concept

常用的动词有 get set read create add update reset delete remove 等。

getQuestion
getUserPosts
getUsers

// bad 有很多近意动词,选一个一直用,不要变来变去
getQuestion
returnUsers
retrieveUsers

函数或方法名尽量采用动词或判断性词汇 Use verbs for function names

函数名一般由一个 动词 加一个 名词 组成,如 getUser getInfo isArray。

getFullYear()  // 取值
toString()     // 转换
isArray()      // 判断

布尔值的命名 Make booleans that read well in if-then statements

布尔值一般用 is can has need 等助动词开头,如 isVisible hasLicense canEvaluate shouldAbort。返回布尔值的函数或方法,命名规则相同,如 Array.isArray(arr)。但这样容易出现函数名和变量名冲突的情况,这个时候可以在函数前加 check get 等区分。

const hasApple = checkHasApple(fruits, 'apple');

// hasApple       是否包含苹果
// checkHasApple  判断是否包含苹果

数值的命名

首选有意义的简短命名,如 width length count,如果没有合适的就采用 numberOfXXX xxxCount 之类的通用命名

width
length
total

maxWidth

numberOfErrors
errorCount

类名用名词 Use nouns for class names

class Car { }
new User()

// bad 类本来就是一类事物的抽象,加动词干啥
class MakeCar { }

字典(Map)的命名

推荐使用 valuesByKey 的方式,如 usersByID。

const usersByID = {
   id12345: { name: 'byted', age: 9 },
   // ...
 };

 // bad
values  // 提供的信息不够充分
keysToValuesMap  // 名字里不要体现类型,类型信息交给 TypeScript 记吧
mapOfKeysToValues
mapFromKeysToValues
原文 https://juejin.cn/post/6977245873797349413
作者:字节前端


链接: https://fly63.com/article/detial/10471

css自定义变量_初次接触CSS变量

本文的目的主要是展示CSS变量是如何工作的。随着Web应用程序变得越来越大,CSS变得越来越大,越来越多,而且很多时候都很乱,在良好的上下文中使用CSS变量,为您提供重用和轻松更改重复出现的CSS属性的机制。

CSS变量(自定义属性)实践指南

Sass和Less这样的预处理器,让我们的CSS代码保持良好的结构和可维护性。像变量、混合(mixins)、循环控制等特性,增强了动态编写CSS的能力,从而减少重复代码,也加快了我们开发速度。

css变量_原生css 中变量的使用

原生css 中变量的使用,这个重要的 CSS 新功能,所有主要浏览器已经都支持了。本文全面介绍如何使用它,你会发现原生 CSS 从此变得异常强大。声明变量的时候,变量名前面要加两根连词线(--),var()函数用于读取变量。

理解var let const区别

JavaScript中var、let、const区别?js中let和const都是es5版本新的命名规范,在此之前定定义一个变量只能用var。我们可以把let和const看做是为了弥补var的一些不足而新设计出来的

一个例子,变量提升和函数提升就是这么简单!

引擎在读取js代码的过程中,分为两步。第一个步骤是整个js代码的解析读取,第二个步骤是执行。在JS代码执行之前,浏览器的解析器在遇到 var 变量名 和function 整个函数 提升到当前作用域的最前面。

CSS变量使用解析

很早直接就了解到CSS变量相关的内容,奈何之前使用价值不高(很多主流浏览器不兼容),最近发现主流浏览器都已经支持了这一变化,CSS变量就像JS的变量,每个类名或者花括号就像一个function,里面的变量只有上下文以内可以获取,这就让CSS有了更多可能性。

let与var的区别,为什么要用let?

var是全局声明,let是块级作用的,只适用于当前代码块;var变量会发生变量提升,let则不会进行变量提升;var 会造成重复赋值,循环里的赋值可能会造成变量泄露至全局

ES6-变量的解构赋值

解构赋值官方解释:按照一定的模式,从数组和对象中提取值,对变量进行赋值,这被称为解构(Destructuring)。变量的解构赋值就是一种写法,掌握了这种写法可以让我们在书写 javascript 代码时可以更加的简单,迅捷。

JS中变量的存储

JS中的变量是保存在栈内存中的:1.基本数据类型的值直接在栈内存中存储;2.值与值之间是独立存在的,修改一个变量不会影响其他变量;对象是保存到堆内存中的,每创建一个新的对象

js 交换变量值的方法总汇

这篇文章总结七种办法来交换a和b的变量值 。最最最简单的办法就是使用一个临时变量了 ,最后我的方案是利用了ES6的解构赋值语法 ,它允许我们提取数组和对象的值,对变量进行赋值

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!