Android开发规范:CodeReview规范(1)

CodeReview输出


CodeReview目的

============

老生常谈==>>>

代码有这几种级别:1,可编译;2,可运行;3,可测试;4,可读;5,可维护;6,可重用。

通过自动化测试的代码只能达到第3层次,而通过code Review的代码可以上升到更高的层次。

1、提升开发人员代码编写质量

2、现有版本的优化

3、开发人员间代码和业务互相熟悉

CodeReview清单 VS Bad Smell

=========================

以下摘抄自网络:

常规项

  • 代码能够工作么?它有没有实现预期的功能,逻辑是否正确等。

  • 所有的代码是否简单易懂?

  • 代码符合你所遵循的编程规范么?这通常包括大括号的位置,变量名和函数名,行的长度,缩进,格式和注释。

  • 是否存在多余的或是重复的代码?

  • 代码是否尽可能的模块化了?

  • 是否有可以被替换的全局变量?

  • 是否有被注释掉的代码?

  • 循环是否设置了长度和正确的终止条件?

  • 是否有可以被库函数替代的代码?

  • 是否有可以删除的日志或调试代码?

安全

  • 所有的数据输入是否都进行了检查(检测正确的类型,长度,格式和范围)并且进行了编码?

  • 在哪里使用了第三方工具,返回的错误是否被捕获?

  • 输出的值是否进行了检查并且编码?

  • 无效的参数值是否能够处理?

文档

  • 是否有注释,并且描述了代码的意图?

  • 所有的函数都有注释吗?

  • 对非常规行为和边界情况处理是否有描述?

  • 第三方库的使用和函数是否有文档?

  • 数据结构和计量单位是否进行了解释?

  • 是否有未完成的代码?如果是的话,是不是应该移除,或者用合适的标记进行标记比如‘TODO’?

测试

  • 代码是否可以测试?比如,不要添加太多的或是隐藏的依赖关系,不能够初始化对象,测试框架可以使用方法等。

  • 是否存在测试,它们是否可以被理解?比如,至少达到你满意的代码覆盖(code coverage)。

  • 单元测试是否真正的测试了代码是否可以完成预期的功能?

  • 是否检查了数组的“越界“错误?

最后笔者收集整理了一份Flutter高级入门进阶资料PDF

以下是资料目录和内容部分截图



里面包括详细的知识点讲解分析,带你一个星期入门Flutter。还有130个进阶学习项目实战视频教程,让你秒变大前端。

网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。

需要这份系统化学习资料的朋友,可以戳这里获取

一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!

//bbs.csdn.net/topics/618156601)**

一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!

  • 11
    点赞
  • 15
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值