前端规范落地,团队级的解决方案

2022-04-17 12:15:19 浏览数 (1)


前言

本文主要讲前端开发时遇到的 编码规范难以落地的问题 以及 解决方案 ,包括 编码规范git commit 规范。

重点在 落实前端团队编码规范 的操作上。跟着我一步一步去做,一定可以将规范落地。

问:要不要制定编码规范?要不要使用 ESLint ?要不要规范化 git 的提交 ? 答:非个人项目 我都建议遵循团队或主流的规范进行编码。写代码和阅读代码是两回事,团队合作的话,代码最好都能让每个成员看着觉得舒服。git 的日志也同样是这个道理,写和读是两回事。

团队开发的项目如果没有开发规范:

  • 日后维护成本大概率会变高。
  • 可能看不懂同事的代码(同事也不一定能看懂你的代码)。
  • 项目不容易扩展。
  • 公司人员流动时,项目难以交接。
  • 丑!

比如这样的代码就非常丑

代码语言:javascript复制
const userInfo ={
  name: "张三",
  age:20,
  gender: '男'
}

function showUserInfo() {
  console.log('姓名:' userInfo.name)
console.log("年龄:"   userInfo.age);
console.log("性别:"  userInfo.gender);
}

showUserInfo()
  • 有些地方使用单引号,有些地方使用双引号。
  • userInfo ={...} 等号后面没空格。
  • age:20 冒号后面没空格。
  • showUserInfo 里的代码有两行没用制表符排版。
  • 有些代码有加分号,有些代码没加分号。
  • 字符串拼接时,部分加号两边没空格。

虽然这段代码是能运行的,但看上去就非常丑。甚至在很多公司中,这种代码都是不合格的,大概率会公开处刑。

至于使用什么规范(比如要不要加分号),本文不做深入探讨。 你可以按照团队协商出来的规范去编码,也可以使用大厂提供的规范。

0 人点赞