代码审查的注意事项

Posted 2021-12-05 mn6364

代码审查的注意事项
代码审查的目的是，一避免存在隐含的重大逻辑错误，上线后导致系统崩溃，二是对开发规范的检验，是否在开发的过程中，遵循开发规范。
注意事项
- 命名规范
我觉得命名规范在项目中是很有意义的，因为 开发是多人协作，版本迭代迅速，维护人员可能会更换的问题，要做到"看其名，知其意"。不能随便乱起名字，a,b,c，这种的，应该是易读，易理解，的。

- 注释
注释，起到的作用就是 解释代码块，容易让别人理解你的代码。我们在项目中，其实会经常遇到人事的变动，可能该阶段是你负责，下阶段就换成其他人了。 那么，如果不写注释的话，让其他人员怎么明白的了解你的代码思路，怎么对你的代码进行维护呢？换位思考一下，你愿意去接受一个没有一点注释的，通篇长代码的项目嘛？估计内心一万只草泥马奔腾而过。所以，为了自己，为了他人，为了社会的和平，还是好好写注释把。

注释分为单行注释和多行注释，单行注释主要是针对一行代码进行的标识。多行注释一般是针对代码块进行的注释，注释内容可以是你的实现思路，该模块的功能是什么。
- 目录结构， 组件划分
目录结构清晰明了，每个文件夹做一件事情，api 文件夹对应的时接口，view文件夹对应的是页面，style文件对应的是样式文件,bussiness是组件等。

按着业务组件和基础组件对组件进行划分，什么是基础组件？什么是业务组件呢
基础组件： 项目中不涉及到业务(心里肯定想的是 这不是废话嘛),更细一点说，该组件我在这个项目中可以用到，在其他项目中也可以用到，比如封装的表格，封装的表格头部的按钮组。但是，表格的渲染的数据是不同的，所以，数据的获取我们在父组件中进行，拿到后传到子组件，按钮触发，请求的接口可能是不同的，所以，数据的传向我们需要在父组件中进行，子组件只需要将事件传到父组件中即可。

**综上所述，基础组件就是 可以复用的组件，数据的来源来自父组件，数据的去向也通过事件传到父组件中去进行操作。**

业务组件：一些涉及到业务的组件，比如，我们的新增侧滑组件，该组件就只能针对当前的项目中去使用。我们可在这里面进行通过接口进行数据的获取，也可以通过接口进行数据的传递。

在代码审查的过程中，通过对组件清晰明了的划分，有助于帮助我们理解项目的业务结构。

- 方法中的逻辑
对函数中的逻辑进行审查，查看该逻辑是否有重大错误的问题，如果没有的话，就要看一下 是否有需要优化的地方。

- sass 的使用
是否将常用的字体大小，颜色等进行变量赋值，是否对一些公共样式 进行混入的写入。

- 混入
在项目中，多次调用的方法可以使用混入的方式。避免重复写大量的代码，使代码整洁。或者，页面中逻辑代码过多，为了代码的整洁，也可以使用混入的方式。