如何让你的代码变得更优雅?这些代码规范和技巧必须知道(进阶必备,建议收藏)

本文详细介绍了JavaScript编程中的代码风格指南,包括换行规则、变量和命名规范、命名空间管理、松耦合与高复用策略,以及函数优化(如提炼函数、减少参数、条件优化和高效循环)的方法。旨在提升代码可读性和复用性,降低开发难度。
摘要由CSDN通过智能技术生成

2.3 换行要一致

  • 在运算符的前面换行,开发者检查更加方便

  • 把后续的语句缩进一个层次,比如使用两个空格

  • 在逗号分隔符的后面换行

  • 方括号或者括号单独占一行。清楚地表明这是语句的结尾,不会迫使读者横向扫寻分号

// 将运算符放在左边,排成一列

let str = ‘我知道你也在向我靠近,’

  • ‘星河万顷都是你的见面礼。’

  • ‘所以我也走向了你,’

  • ‘暮色千里皆是我的回礼。’

  • ‘今夜星光月夜皆归你,我也归你~’

// 方括号单独占一行,下一条语句就容易识别了

// 使用尾部逗号,更容易维护

let addressArr = [

‘湖南省’, ‘湖北省’, ‘广西省’,

‘江西省’, ‘江苏省’, ‘内蒙古自治区’,

‘台湾省’, '澳门, ‘香港’,

];

在这里插入图片描述

3. 命名规范


3.1 变量

命名规则

  • 变量名使用a - z、A - Z、0 - 9、下划线和$符号

  • 变量名不要以数字开头

  • 语义化(看其名,知其意)

作用域

  • 当变量作用域是整个模块时使用驼峰式(模块名字空间的所有地方都可以访问该变量)

  • 当变量作用域不是整个模块时使用下划线 (模块名字空间内的某个函数的局部变量)

  • 确保所有模块作用域内的变量至少有两个音节,这样作用域就会很清晰(例如下:)

  • 用户中心 ⇒ userCenter

  • 商品列表 ⇒ goodsList

  • 消息通知 ⇒ messageInfo

  • 再来一组例子:

| 变量初始名 | 局部作用域 | 模块作用域 |

| — | — | — |

| str | direction_str | directionStr |

| id | goods_id | goodsId |

| msg | user_msg | userMsg |

  • 全局变量用 const 定义,常量性质,字母全部大写(尽量少定义)

3.2 命名空间

  • 早期的JavaScript代码比较简单,单独在一张页面上使用,所以大部分时间不需要考虑命名空间的问题,使用全局变量,而不会有什么影响。

  • 但是随着JavaScript应用的蓬勃发展和第三方类库的普遍使用,全局变量的数据可能会急剧上升

  • 地域之门从此便开启了。(比如,当两个代码库声明了相同的全局变量时)

  • 使用单一的全局函数,把其他所有变量的作用域限制在该函数里面,就可以极大地减少这种问题

// 模拟一个第三方库 => jQuery

(function(window){

// 此变量只会在此区域生效,使用完之后垃圾回收机制自动回收

// 不会污染全局变量

let jquery = {};

})(window)

  • 命名空间的细粒度划分

// 在 jquery.js 中

let jquery = (function () {

// some code here

}());

// 在 jquery.dom.js 中

let jquery.dom= (function () {

// some code here

}());

// 在 jquery.css.js 中

let jquery.css = (function () {

// some code here

}());

在这里插入图片描述

4. 松耦合,高复用


4.1 什么叫耦合?

  • 指一程序中,模块及模块之间信息或参数依赖的程度(官方解释)

  • 举个例子:

  • 多个零件在一起,组成了一辆车,各零件之间存在耦合

  • 电脑主机与显示屏,存在耦合

  • 在程序语言中,也会有耦合,比如A模块依赖于B模块

  • 我们通常是不需要耦合度很高的,除非特定组件,这样才可以达到高复用

  • 举个例子,比如布加迪的轮胎,是找米其林高度定制的,只能适用于布加迪车型,其它品牌车型是用不了的(耦合度越高,复用性越低

  • 在这里插入图片描述

  • 而电脑主机与显示器,一般耦合度就很低了,A品牌电脑主机可以用B,C,D品牌各型号的显示器,所以复用性高,可以自由组合。

  • 在这里插入图片描述

4.2 松耦合

  • 当修改一个组件而不需要更改其他组件时,就做到了松耦合

  • 耦合度视情况而定,复用性组件必须低耦合

如何松耦合?

  • 将JS从CSS中抽离:不要使用CSS表达式

//不好的做法

.box{width: expression(document.body.offsetWidth + ’px’)}

  • 将CSS从JS中抽离:通过JS修改CSS样式时,使用className或classList,不要逐条修改style样式

//不好的做法一

ele.style.color = ‘red’;

ele.style.left= ‘10px’;

//不好的做法二

ele.style.cssText =‘color:red;left:10px;’;

.reveal{color:red;left:10px;}

//好的做法一

ele.className += ‘reveal’;

//好的做法二

ele.classList.add(‘reveal’);

  • 将JS从HTML中抽离:从JS文件放入外置文件中

  • 将HTML从JS中抽离:不要在innerHTML中拼接DOM结构,而是使用字符串模板,如handlerbars

在这里插入图片描述

5. 函数优化


5.1 提炼函数

  • 在javascript开发中,大部分时间都在与函数打交道,所以希望这些函数有着良好的命名,函数体内包含的逻辑清晰明了

  • 如果一个函数过长,不得不加上若干注释才能让这个函数显得易读一些,那这些函数就很有必要进行重构

  • 如果在函数中有一段代码可以被独立出来,那最好把这些代码放进另外一个独立的函数中,这是一种很常见的优化工作。

  • 项目越大,必须拆分得越细,好维护(函数也是如此)

  • 千万不要一个函数从奶奶家写到外婆家去了

这样做的好处主要有以下几点:

  • 避免出现超大函数

  • 独立出来的函数有助于代码复用

  • 独立出来的函数更容易被覆写

  • 独立出来的函数如果拥有一个良好的命名,它本身就起到了注释的作用

比如在一个负责取得用户信息的函数里面,还需要打印跟用户信息有关的信息,那么打印的语句就可以被封装在一个独立的函数里:

let getUserInfo = function(){

ajax( ‘http:// xxx.com/userInfo’, function( data ){

console.log( 'userId: ’ + data.userId );

console.log( 'userName: ’ + data.userName );

console.log( 'nickName: ’ + data.nickName );

});

};

//改成:

let getUserInfo = function(){

ajax( ‘http:// xxx.com/userInfo’, function( data ){

printDetails( data );

});

};

let printDetails = function( data ){

console.log( 'userId: ’ + data.userId );

console.log( 'userName: ’ + data.userName );

console.log( 'nickName: ’ + data.nickName );

};

5.2 尽量减少参数

  • 调用一个函数时需要传入多个参数,那这个函数是让人望而生畏的(甚至调用起来还会骂娘~)

  • 必须搞清楚这些参数代表的含义,必须小心翼翼地把它们按照顺序传入该函数。

  • 在实际开发中,向函数传递参数不可避免,但应该尽量减少函数接收的参数数量

比如我们需要封装一个CSS操作库:

  • 第一版的代码

function cssTransform(ele, attr, val){

// ele 要操作的元素

// attr 运动属性 缩放,旋转

// val 具体值

if(!ele.transform){

ele.transform = {};

}

if(typeof val === “undefined”){

// 取值阶段

// 取不到 设置默认值

if(typeof ele.transform[attr] === “undefined”){

switch(attr){

case “scale”:

case “scaleX”:

case “scaleY”:

case “scaleZ”:

// attr是scale 默认值是1 其它都是0

ele.transform[attr] = 1;

break;

default:

ele.transform[attr] = 0;

}

}

// 取值完毕 返回该值

return ele.transform[attr];

}else{

// 赋值阶段

ele.transform[attr] = val; // 设置属性 方便取值

let transformVal = “”;

for(var s in ele.transform){

switch(s){

case “scale”:

case “scaleX”:

case “scaleY”:

case “scaleZ”:

transformVal += " " + s + “(”+(ele.transform[s])+“)”;

break;

case “rotate”:

case “rotateX”:

case “rotateY”:

case “rotateZ”:

case “skewX”:

case “skewY”:

transformVal += " " + s + “(”+(ele.transform[s])+“deg)”;

break;

default:

transformVal += " " + s + “(”+(ele.transform[s])+“px)”;

}

ele.style.WebkitTransform = ele.style.transform = transformVal;

}

}

}

  • 我们需要传入三个参数,这就导致了传参的复杂性

  • 可以将它绑定到HTML元素上,减少传参

HTMLElement.prototype.cssTransform = function (prop, value){

var transform,

transformValue = “”;

if(this.transform === undefined) {

this.transform = transform = Object.create(null);

}

if(value !== undefined){

// 赋值阶段

this.transform[prop] = value;

transform = this.transform;

for(var name in transform){

switch(name){

case “scale”:

case “scaleX”:

case “scaleY”:

case “scaleZ”:

transformValue += " " + name + “(”+ transform[name]+“)”;

break;

case “rotate”:

case “rotateX”:

case “rotateY”:

case “rotateZ”:

case “skewX”:

case “skewY”:

transformValue += " " + name + “(”+ transform[name] + “deg)”;

break;

default:

transformValue += " " + name + “(”+ transform[name] + “px)”;

}

this.style.WebkitTransform = this.style.transform = transformValue;

}

}else{

// 取值

return this.transform[prop];

}

}

  • 现在就只需要两个参数了

  • 核心代码没变,事件直接绑定在元素上,每一个html都拥有这个原型方法

  • 调用更加方便,传参更加简单

在这里插入图片描述

6.条件优化


6.1 合并条件判断

  • 如果一个函数体内有一些条件分支语句,而这些条件分支语句内部散布了一些重复的代码,那么就有必要进行合并去重工作。

  • 假如有一个分页函数paging(),该函数接收一个参数currPage,currPage表示即将跳转的页码。

  • 在跳转之前,为防止currPage传入过小或者过大的数字,要手动对它的值进行修正,详见如下代码

let paging = function( currPage ){

if ( currPage == 0 ){

currPage = 0;

jump( currPage ); // 跳转

}else if ( currPage == totalPage ){

currPage = totalPage;

jump( currPage ); // 跳转

}else{

jump( currPage ); // 跳转

}

};

  • 可以看到,负责跳转的代码jump(currPage)在每个条件分支内都出现了,所以完全可以把这句代码独立出来

let paging = function( currPage ){

if ( currPage == 0 ){

currPage = 0;

}else if ( currPage == totalPage ){

currPage = totalPage;

}

jump( currPage ); // 把jump 函数独立出来

};

6.2 条件语句过多,提炼成函数

  • 在程序设计中,复杂的条件分支语句是导致程序难以阅读和理解的重要原因,而且容易导致一个庞大的函数

  • 假设现在有一个需求是编写一个计算商品价格的 getPrice(),商品的计算只有一个规则:如果当前正处于夏季,那么所有冬装将以5折出售

let getPrice = function( price ){

let date = new Date();

if ( date.getMonth() > 6 && date.getMonth() < 10 ){ // 冬天

return price * 0.5;

}

return price;

};

  • 判断是否处于夏季

if ( date.getMonth() > 6 && date.getMonth() < 10 )

  • 这句代码要表达的意思很简单,就是判断当前是否正处于夏天(7 - 9月)。

  • 尽管这句代码很短小,但代码表达的意图和代码自身还存在一些距离,阅读代码的人必须要多花一些精力才能明白它传达的意图。

  • 其实可以把这句代码提炼成一个单独的函数,既能更准确地表达代码的意思,函数名本身又能起到注释的作用

let isSummer = function(){

let date = new Date();

return date.getMonth() > 6 && date.getMonth() < 10;

};

let getPrice = function( price ){

if ( isSummer() ){ // 夏天

return price * 0.5;

}

return price;

};

在这里插入图片描述

7. 循环优化


7.1 高效循环

  • 在函数体内,如果有些代码实际上负责的是一些重复性的工作

  • 合理利用循环不仅可以完成同样的功能,还可以使代码量更少

  • 以for循环为例,最常规写法

for (let i = 0; i < arr.length; i++) {

// do something…

}

  • 大多数人都是这种写法,这种写法的缺点在于,每次循环都要去读取一次数组的长度,性能上并不友好

  • 变量情况的优化写法

for (let i = 0, j = arr.length; i < j; i++) {

// do something…

}

  • 将长度进行存储,之后循环无需再去读取长度

自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数前端工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年Web前端开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。

img

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上前端开发知识点,真正体系化!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:前端)

最后的最后

面试题千万不要死记,一定要自己理解,用自己的方式表达出来,在这里预祝各位成功拿下自己心仪的offer。
需要完整面试题的朋友可以点击蓝色字体免费获取

大厂面试题

面试题目录

数前端工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!**

因此收集整理了一份《2024年Web前端开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。

[外链图片转存中…(img-MVmSelK1-1712332878565)]

[外链图片转存中…(img-jSDe94WP-1712332878565)]

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上前端开发知识点,真正体系化!

[外链图片转存中…(img-VjkF1qY4-1712332878565)]

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:前端)

最后的最后

面试题千万不要死记,一定要自己理解,用自己的方式表达出来,在这里预祝各位成功拿下自己心仪的offer。
需要完整面试题的朋友可以点击蓝色字体免费获取

[外链图片转存中…(img-qLThBv2v-1712332878565)]

[外链图片转存中…(img-4wPKS27L-1712332878566)]

[外链图片转存中…(img-VreRU3gV-1712332878566)]

[外链图片转存中…(img-VjlLRZHf-1712332878566)]

  • 5
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值