6个规则去净化你的代码

简介: 可读性代码就是可维护性代码!

可读性代码就是可维护性代码!


1、注重命名


为一个事件命名是很困难的。虽然困难但是非常有必要。


想象以下,将两个数组合并成一个数组,并生成一个唯一值的数组。那么你会怎么命名它呢?我们也许会这样命名?


function mergeNumberListIntoUniqueList(listOne, listTwo) {
  return [...new Set([...listOne, ...listTwo])]
}
复制代码


上面的命名并不糟糕,但是还不是很友好。你可以将一个功能函数拆分为两个功能函数,这样命名更友好和函数复用性更好。


function mergeLists(listOne, listTwo) {
  return [...listOne, ...listTwo]
}
function createUniqueList(list) {
  return [...new Set(list)]
}
复制代码


2、IF语句简化


假设我们有下面的代码:


if(value === 'duck' || value === 'dog' || value === 'cat') {
  // ...
}
复制代码


我们可以这样解决:


const options = ['duck', 'dog', 'cat'];
if (options.includes(value)) {
  // ...
}
复制代码


将乱七八糟的条件判断放到一个变量中存储,比看臃肿的表达式要好很多。


3、及早返回


有下面的代码:


function handleEvent(event) {
  if (event) {
    const target = event.target;
    if (target) {
      // Your awesome piece of code that uses target
    }
  }
}
复制代码


及早返回使得我们的代码更加易读:


function handleEvent(event) {
  if (!event || !event.target) {
    return;
  }
  // Your awesome piece of code that uses target
}
复制代码


4、解构赋值


javascript中,我们可以对objectsarrays进行解构赋值。


例如:


// object 解构赋值
const numbers = {one: 1, two: 2};
const {one, two} = numbers;
console.log(one); // 1
console.log(two); // 2
// array 解构赋值
const numbers = [1, 2, 3, 4, 5];
const [one, two] = numbers;
console.log(one); // 1
console.log(two); // 2
复制代码


5、童子军规则


童子军有一条规则:永远保持离开时的露营比你发现它时更整洁。如果你在地面上发现了脏东西,那么无论是否是你留下的,你都要将它清理干净。你要有意地为下一组露营者改善环境。


我们编写代码也是这样子,如果你在代码中发现了脏代码,那么你可以尝试去修改它,即使是一个没有被引用到的变量名。


6、代码风格


在你的团队中使用一种代码风格,比如限定代码缩进的规范是两空格呢还是四空格;使用单引号呢还是双引号呢;使用同类的一种框架呢,还是流行两种解决方案的框架呢...这样团队中人员接手项目的成本就会降低,开发人员的心里减少排斥感~



相关文章
|
7月前
|
机器学习/深度学习 算法 安全
内容过滤算法:构建数字世界的守护者
内容过滤算法:构建数字世界的守护者
|
6月前
|
安全 网络安全 数据安全/隐私保护
关于双面恶魔攻击的定义、检测和预防的最佳实践
关于双面恶魔攻击的定义、检测和预防的最佳实践
|
算法 数据可视化
使用点要素匹配在杂乱场景中检测对象
使用点要素匹配在杂乱场景中检测对象。
117 0
|
XML Java API
网站是怎么屏蔽脏话的呢:简单学会SpringBoot项目敏感词、违规词过滤方案
一个社区最重要的就是交流氛围与审查违规,而这两者都少不了对于敏感词进行过滤的自动维护措施。基于这样的措施,我们才能基本保证用户在使用社区的过程中,不至于被敏感违规词汇包围,才能够正常的进行发布帖子和评论,享受美好的社区氛围。目前,对于 springboot 项目也有较为成熟的敏感词过滤方案。
546 0
网站是怎么屏蔽脏话的呢:简单学会SpringBoot项目敏感词、违规词过滤方案
|
消息中间件 人工智能 算法
很全的敏感词匹配系统的设计与实践(1)
很全的敏感词匹配系统的设计与实践(1)
|
数据采集 算法 数据处理
期现套利系统开发源码规则解析
期现套利系统开发源码规则解析
|
存储 算法
很全的敏感词匹配系统的设计与实践(2)
很全的敏感词匹配系统的设计与实践(2)
|
数据采集 SQL NoSQL
爬虫识别-流程规则读取总结|学习笔记
快速学习爬虫识别-流程规则读取总结
爬虫识别-流程规则读取总结|学习笔记
|
SQL 数据采集 大数据
爬虫识别-流程规则读取|学习笔记
快速学习爬虫识别-流程规则读取
爬虫识别-流程规则读取|学习笔记
|
SQL 安全 数据安全/隐私保护