zoukankan      html  css  js  c++  java
  • 如何进行CodeReview

    一、代码规范的要点

    代码规范主要分为风格规范与设计规范两大类:

    1、代码风格规范

    主要是文字上的规定,看似表面文章,实际上非常重要。

    具体有如下几个方面:

    (1)缩进

    (2)行宽

    (3)断行/空白行

    (4)括号

    (5)命名(字母、下划线、大小写)

    (6)注释

    A、单行注释

    B、多行注释

    C、变量/方法/类/包注释

    2、代码设计规范

    牵涉到程序设计、模块之间的关系、设计模式等方方面面的通用原则。

    主要有如下几个方面:

    (1)方法/函数的写法

    A、方法命名

    B、方法参数(入参/返回值)

    C、方法的职责

    比如:避免out型参数、用枚举替代boolean、同类型参数最好间隔开、超过4个参数最好抽象成一个类、参数和返回值最好不传null、用卫述句减少if嵌套、方法连续调用要注意空指针、for循环优于while

    (2)异常处理原则

    比如:异常的抽象层次应该与方法所在的层次一致,业务层方法要对底层异常进行转译为业务异常

    (3)分层/类设计原则

    比如:在某一个层进行防御式校验,某一层按约定不做参数校验;比如调用到的外部接口封装为facade防腐层;

    (4)单测原则

    比如:快速/及时、独立、可重复、覆盖主要代码路径、无副作用

    二、CodeReview注意事项

    主要根据团队设定的代码规范,来review团队成员的代码,大致有以下几个方面:

    1、代码有没有不符合代码规范的

    比如:命名、注释

    2、代码有没有(业务/算法)逻辑错误

    比如:功能与需求有偏差;参数传递顺序出错;方法的边界条件有没有考虑等

    3、代码有没有回归错误

    比如:之前的功能回归测试不通过

    4、代码有没有潜在性能问题

    比如:考虑大数据量、大并发量下的性能下sql是否有问题?是否会有内存泄露?死锁等

    5、代码有没有其他待改进的地方

    比如:可扩展性/过度设计

    ——参考《构建之法》



    作者:go4it
    链接:https://www.jianshu.com/p/e65d83405914
    來源:简书
    著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。
  • 相关阅读:
    [转]Torch是什么?
    去掉 CONSOLE 窗口(转)
    最短路径问题
    最短路,dijstra算法
    最短路,floyd算法,图的最短路径
    freckles
    还是畅通工程,最小生成树kruskal
    More is better
    畅通工程
    人见人爱
  • 原文地址:https://www.cnblogs.com/ricklz/p/9176807.html
Copyright © 2011-2022 走看看