Code Review防毒打指南

简介: Code Review防毒打指南

命名规范

取名过于简单,无法清晰表达含义。

可能在自己编写代码的时候可以理解,但是别人第一眼看到这样的命名时,是完全不知道它具体表达了什么含义的,很难阅读

// 单字符,剪短单词作为变量名
 let flag = false;
 for(f in markedFiles){
   //handler each marked file
 }

命名风格不一,影响代码阅读

他们都是判断性函数的命名,但是使用不同命名风格

我们应该尽量养成一个固定命名思路或者命名风格

//多种风格的方法名
 isProcessRunning()
 checkIfPageClosed()

建议

  1. 可以适当参照现有代码的命名风格。
  2. 命名要能够清晰展现有关的含义(好的命名的基本要求)
    -较长清晰的命名优于简短模糊的命名,不要过于追求简短
    -一个命名花费的思考是值得的。
  3. 命名技巧学习:
    -多阅读书籍、教程、知名源码等等,学习命名思路和技巧。

注释不合规

修改代码不更新注释,造成误导

//do something about A 
 Function()
 {
     // do some actions about B
 }

无意义的注释(如日志型注释,废弃的代码)

这类注释对于代码逻辑没有任何的理解上的帮助,相反还增加了篇幅,随着现代项目管理工具越来越强大已经不需要了。

/*
  * Date: 1 Jan
  * Author: Hy
  * Change: Update this function for fixing bug : ...
  * ........
 */
 Function(){
     /*
     OldFlow();
     */
     NewFlow();
 }

过多篇幅的注释

别人不一定有耐心去读我们的注释,如果代码不够清晰,注释再多,也不利于后期的修改和维护。

所以过多篇幅的注释出现在了我们代码中,我们要考虑是不是可以让代码更清晰

/*
     multi-lines
 */
 Function(){
     ......
 }

建议:

  1. 避免写出坏注释
    -不达意的注释
    -含有误导的注释
    -与逻辑无关的注释
  2. 及时更新注释
  3. 清晰代码不需要太多注释说明的

函数封装和复用

不使用团队封装的工具库,自己重新实现

公司封装这些工具库、组件的目的是让所有人使用或调用的时候可以在同一个规范上使用同样的代码,便于后续问题的排查,保证我们代码的质量。

自己重新实现容易带来一些阅读、后期维护等问题。

函数过长,缺乏提炼

Function()
 {
     // do A
     ...
     // do B
     ...
     // do C
     ...
     ...
 }

三次及以上重复代码不做复用

重复两次时可做可不做,一旦到达三次一定封装

修改公共库时只考虑到自身业务逻辑

只顾及自己的业务实现,不兼容他人使用场景

建议:

  1. 使用组件时,先看看是否团队进行过封装
  2. 按照职责设计和提炼函数,尽量做到函数单一职责
  3. 相同逻辑的代码积极复用

不合理的变量定义

变量定义不考虑解耦

例子中,此种域名如果我们定义多个,就没有做到解耦以及复用

//方法体中的整型/字符串定义
 let loginUrl = "www.xxx.com/login"
 let helpUrl = "www.xxx.com/help"

根据使用场景判断是否应该动态生成内容

const systemPath = "C:\";

例如Windows的操作系统一般是C盘,但这个可以手动更改

如果代码中我们设置为C盘,那后续如果用户本身系统盘并不是C盘,那就会出问题,应通过API或其他方式进行获取、



目录
相关文章
|
JavaScript 前端开发 安全
15个最佳的代码评审(Code Review)工具
  代码评审可以被看作是计算机源代码的测试,它的目的是查找和修复引入到开发阶段的应用程序的错误,提高软件的整体素质和开发者的技能。代码审查程序以各种形式,如结对编程,代码抽查等。在这个列表中,我们编制了15个最好的代码审查工具,这将有助于开发者节省代码审查时间。
4469 0
|
4月前
|
算法 Java 测试技术
卓越工程之如何做好Code Review
本文主要从我们为什么需要CR?CR面临哪些挑战?CR的最佳实践几个方面分析,希望可以给读者一些参考。
|
4月前
|
Java 测试技术 p3c
我们如何做Code Review
我们如何做Code Review
106 0
|
敏捷开发 开发者
Code Review 全面审查清单
Code Review 全面审查清单
564 0
Code Review 全面审查清单
|
监控 算法 程序员
大厂怎么做Code Review?
发现坏味道的实践,就是Code Review:对计算机源代码系统化地审查,常用软件同行评审的方式进行,其目的是在找出及修正在软件开发初期未发现的错误,提升软件质量及开发者的技术
270 0
|
开发框架 安全 IDE
|
缓存 算法 安全
代码评审(Code Review)
代码评审(Code Review)
602 0
|
缓存 人工智能 监控
【如何有效做Code Review】8行代码提出的21个问题
- 很多同学都有这个疑问,如何结构化体系化的做CR?如何综合应用各种手段尽快及早的发现代码问题和缺陷? - 下面围绕这个实例,抛砖引玉,大家可以一起探讨;  - 实例如下 ,短短8行代码,通过CR可以发现多少问题呢?21处;这段代码谁写的不重要,探讨的重点是如何全面发现其中的问题和隐患;  
5849 0
【如何有效做Code Review】8行代码提出的21个问题
|
测试技术 开发者
|
程序员 开发者