【前端开发必备小技巧】前端代码规范JavaScript篇

2024-08-30 02:36

本文主要是介绍【前端开发必备小技巧】前端代码规范JavaScript篇,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

  • 🟢 前端代码规范
  • 🟢 一、前端代码规范JavaScript篇
    • 👉1、JavaScript规范
        • 👉1.1、命名
        • 👉1.2、代码格式
        • 👉1.3、字符串
        • 👉1.4、对象声明
        • 👉1.5、使用 ES6,7
        • 👉1.6、 括号
        • 👉1.7、 undefined 判断
        • 👉1.8、 条件判断和循环最多三层
        • 👉1.9、 this 的转换命名
        • 👉1.10、慎用 console.log
  • ✒️总结


🟢 前端代码规范

规范的目的是为了编写高质量的代码,让你的团队成员每天得心情都是愉悦的,大家在一起是快乐的。
引自《阿里规约》的开头片段:
…现代软件架构的复杂性需要协同开发完成,如何高效地协同呢?无规矩不成方圆,无规范难以协同,比如,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全,试想如果没有限速,没有红绿灯,谁还敢上路行驶。对软件来说,适当的规范和标准绝不是消灭代码内容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的统一方式一起做事,提升协作效率,降低沟通成本。代码的字里行间流淌的是软件系统的血液,质量的提升是尽可能少踩坑,杜绝踩重复的坑,切实提升系统稳定性,码出质量。

🟢 一、前端代码规范JavaScript篇

在这里插入图片描述

👉1、JavaScript规范

👉1.1、命名
  1. 采用小写驼峰命名 lowerCamelCase,代码中的命名均不能以下划线,也不能以下划线或美元符号结束
    反例:name /name/names
  2. 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelcase风格,必须遵从驼峰形式。
    正例:1ocalvalue /getHttpMessage()/inputuserId
    其中 method 方法命名必须是 动词 或者 动词+名词 形式
    正例:saveshopcarData /openshopcarInfoDialog
    反例:save /open/show/go
    特此说明,增制查改,详情统一使用如下5个单词,不得使用其他(目的是为了统一各个端)
    add /update /delete /detail / get
  • 附: 函数方法常用的动词:
    • get 获取 / set 设置,
    • add 增加 / remove 删除
    • create 创建 / destory 移除
    • start 启动 / stop 停止
    • open 打开 / close 关闭
    • read 读瑕 / write 写入
    • load 载入 / save 保存
    • create 创建 / destroy 销毁
    • begin 开始 / end 结束
    • backup 备份 / restore 恢复
    • import 导入 / export 导出
    • split 分割 / merge 合并
    • inject 注入 / extract 提取
    • attach 附着 / detach 脱离
    • bind 绑定 / separate 分离
    • view 查看 / browse 浏览
    • edit 编辑 / modify 修改
    • select 选取 / mark 标记
    • copy 复制 / paste 粘贴
    • undo 撤销 / redo 重做
    • insert 插入 / delete 移除
    • add 加入 / append 添加
    • clean 清理 / clear 清除
    • index 索引 /sort 排序
    • find 查找 / search 搜索
    • increase 增加 / decrease 减少
    • play 播放 / pause 暂停
    • launch 启动 / run 运行
    • compile编译 / execute 执行
    • debug 调试 / trace 跟踪
    • observe 观察 / listen 监听
    • build 构建 / publish 发布
    • input 输入 / output 输出
    • encode 编码 / decode 解码
    • encrypt 加密 / decrypt 解密
    • compress 压缩 / decompress解压缩
    • pack 打包 /unpack 解包
    • parse 解析 / emit 生成
    • connect 连接 / disconnect 断开
    • send 发送 / receive 接收
    • download 下载 / upload 上传
    • refresh 刷新 / sychronize 同步
    • update 更新 / revert 复原
    • lock 锁定 / unlock 解锁
    • check out 签出 / check in 签入
    • submit 提交 / commit 交付
    • push 推 / pull 拉
    • expand 展开 / collapse 折叠
    • begin 起始 / end 结束
    • start 开始 / finish 完成
    • enter 进入 / exit 退出
    • abort 放弃 / quit 离开
    • obsolete 废弃 / depreciate 废旧
    • collect 收集 / aggregate 聚集
  1. 常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要名字长。
    正例:MAX_STOCK_COUNT
    反例: MAX_COUNT
👉1.2、代码格式

使用2个空格进行缩进
正例:

if(x<y){x+=10;
}else{x+=1;
}

不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性

说明:任何情形,没有必要插入多个空行进行隔开。

👉1.3、字符串

统一使用单引号('),不使用双引号(")。这在创建 HTML 字符串非常有好处:
正例:

let str='hello world'
let testDiv='<div id="test"></div'

反例

let str='hello world'
let testDiv="<div id='test'></div"
👉1.4、对象声明
  1. 使用字面值创建对象
    正例:let user ={};
    反例:let user =new object();
  2. 使用字面量来代替对象构造器

正例:

var user ={age:0,name:1,city:3
}

反例

var user =new object();
user.age =0;
user.name =0;
user.city =0;
👉1.5、使用 ES6,7

必须优先使用 ES6,7 中新增的语法糖和函数。这将简化你的程序,并让你的代码更加灵活和可复用。

必须强制使用 ES6,ES7 的新语法,比如箭头的数、await / async,解构,let, for…of等等

👉1.6、 括号

下列关键字后必须有大括号(即使代码块的内容只有一行):if,else,for,while,do,switch,try,catch,finally,with.

正例:

if(condition){d5something();
}

反例

if(condition){d5something();}
👉1.7、 undefined 判断

永远不要直接使用 undefined 进行变量判断;使用 sypeof和字符串’undefined’对变量进行判断。

正例:

if(typeof person === 'undefined'){
}

反例

if(person === undefined){
}
👉1.8、 条件判断和循环最多三层

条件判断能使用三目运算符和逻辑运算符解决的,就不要使用条件判断,但是谨记不要写太长的三目运算符。如果超过 3 层请抽成函数,并写清楚注释。

👉1.9、 this 的转换命名

对上下文 this 的引用只能使用’self来命名

👉1.10、慎用 console.log

因 çonsole.log大量使用会有性能问题,所以在非 webpack 项目中谨慎使用 log 功能

✒️总结

如果这篇【文章】有帮助到你💖,希望可以给我点个赞👍,创作不易,如果有对前端端或者对python感兴趣的朋友,请多多关注💖💖💖,咱们一起探讨和努力!!!
👨‍🔧 个人主页 : 前端初见

这篇关于【前端开发必备小技巧】前端代码规范JavaScript篇的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1119561

相关文章

Spring Boot @RestControllerAdvice全局异常处理最佳实践

《SpringBoot@RestControllerAdvice全局异常处理最佳实践》本文详解SpringBoot中通过@RestControllerAdvice实现全局异常处理,强调代码复用、统... 目录前言一、为什么要使用全局异常处理?二、核心注解解析1. @RestControllerAdvice2

Spring IoC 容器的使用详解(最新整理)

《SpringIoC容器的使用详解(最新整理)》文章介绍了Spring框架中的应用分层思想与IoC容器原理,通过分层解耦业务逻辑、数据访问等模块,IoC容器利用@Component注解管理Bean... 目录1. 应用分层2. IoC 的介绍3. IoC 容器的使用3.1. bean 的存储3.2. 方法注

Spring事务传播机制最佳实践

《Spring事务传播机制最佳实践》Spring的事务传播机制为我们提供了优雅的解决方案,本文将带您深入理解这一机制,掌握不同场景下的最佳实践,感兴趣的朋友一起看看吧... 目录1. 什么是事务传播行为2. Spring支持的七种事务传播行为2.1 REQUIRED(默认)2.2 SUPPORTS2

怎样通过分析GC日志来定位Java进程的内存问题

《怎样通过分析GC日志来定位Java进程的内存问题》:本文主要介绍怎样通过分析GC日志来定位Java进程的内存问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、GC 日志基础配置1. 启用详细 GC 日志2. 不同收集器的日志格式二、关键指标与分析维度1.

Java进程异常故障定位及排查过程

《Java进程异常故障定位及排查过程》:本文主要介绍Java进程异常故障定位及排查过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、故障发现与初步判断1. 监控系统告警2. 日志初步分析二、核心排查工具与步骤1. 进程状态检查2. CPU 飙升问题3. 内存

java中新生代和老生代的关系说明

《java中新生代和老生代的关系说明》:本文主要介绍java中新生代和老生代的关系说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、内存区域划分新生代老年代二、对象生命周期与晋升流程三、新生代与老年代的协作机制1. 跨代引用处理2. 动态年龄判定3. 空间分

Java设计模式---迭代器模式(Iterator)解读

《Java设计模式---迭代器模式(Iterator)解读》:本文主要介绍Java设计模式---迭代器模式(Iterator),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,... 目录1、迭代器(Iterator)1.1、结构1.2、常用方法1.3、本质1、解耦集合与遍历逻辑2、统一

Java内存分配与JVM参数详解(推荐)

《Java内存分配与JVM参数详解(推荐)》本文详解JVM内存结构与参数调整,涵盖堆分代、元空间、GC选择及优化策略,帮助开发者提升性能、避免内存泄漏,本文给大家介绍Java内存分配与JVM参数详解,... 目录引言JVM内存结构JVM参数概述堆内存分配年轻代与老年代调整堆内存大小调整年轻代与老年代比例元空

深度解析Java DTO(最新推荐)

《深度解析JavaDTO(最新推荐)》DTO(DataTransferObject)是一种用于在不同层(如Controller层、Service层)之间传输数据的对象设计模式,其核心目的是封装数据,... 目录一、什么是DTO?DTO的核心特点:二、为什么需要DTO?(对比Entity)三、实际应用场景解析

Java 线程安全与 volatile与单例模式问题及解决方案

《Java线程安全与volatile与单例模式问题及解决方案》文章主要讲解线程安全问题的五个成因(调度随机、变量修改、非原子操作、内存可见性、指令重排序)及解决方案,强调使用volatile关键字... 目录什么是线程安全线程安全问题的产生与解决方案线程的调度是随机的多个线程对同一个变量进行修改线程的修改操