如何做代码Review?

简介: 10月更文挑战第3天

为什么要做代码Review?
提高代码质量,提升自身水平

及早发现潜在缺陷与Bug,,降低事故成本
促进团队内部知识共享,提高团队整体水平

保证项目组人员的良好沟通
避免开发人员犯一些很常见,很普遍的错
不要嫌麻烦和浪费时间,其实只要坚持下来,团队收益会非常大。
添加必要的注释

其实,写代码的时候,没有必要写太多的注释,因为好的方法名、变量名,就是最好的注释。以下就是总结的一些注释规范:
所有的类都必须添加创建者和创建日期,以及简单的注释描述
方法内部的复杂业务逻辑或者算法,需要添加清楚的注释
一般情况下,注释描述类、方法、变量的作用

任何需要提醒的警告或TODO,也要注释清楚
如果是注释一行代码的,就用//;如果注释代码块或者接口方法的,有多行/ */
一块代码逻辑如果你站在一个陌生人的角度去看,第一遍看不懂的话,就需要添加注释了

目录
相关文章
|
6月前
|
NoSQL 安全 测试技术
为什么要做代码Review?
提高代码质量,提升自身水平 及早发现潜在缺陷与Bug,,降低事故成本 促进团队内部知识共享,提高团队整体水平 保证项目组人员的良好沟通 避免开发人员犯一些很常见,很普遍的错误
|
4月前
|
人工智能 监控 测试技术
|
6月前
|
算法 Java 测试技术
卓越工程之如何做好Code Review
本文主要从我们为什么需要CR?CR面临哪些挑战?CR的最佳实践几个方面分析,希望可以给读者一些参考。
|
6月前
|
Java 测试技术 p3c
我们如何做Code Review
我们如何做Code Review
124 0
|
SQL 缓存 架构师
一文梳理 Code Review 方法论与实践总结
作为卓越工程文化的一部分,Code Review 其实一直在进行中,只是各团队根据自身情况张驰有度,松紧可能也不一,这里简单梳理一下 CR 的方法和团队实践。
648 9
一文梳理 Code Review 方法论与实践总结
|
SQL 缓存 架构师
一文梳理Code Review方法论与实践总结
相信Code Review每天都在进行,但代码评审应该怎么做,评审范围有哪些,评审标准在哪里,怎样可以避免流于形式,这里结合自己的实践来聊一聊。
29416 10
一文梳理Code Review方法论与实践总结
|
监控 算法 程序员
大厂怎么做Code Review?
发现坏味道的实践,就是Code Review:对计算机源代码系统化地审查,常用软件同行评审的方式进行,其目的是在找出及修正在软件开发初期未发现的错误,提升软件质量及开发者的技术
301 0
|
前端开发 JavaScript
review学弟的前端代码,我发现了这三个问题
之前在工作室分配给学弟一个任务:做一个网上报名的应用,做完后上传到仓库后,我review了一下,发现了不少问题,我也经历过这个阶段,所以我通过这篇文章总结了一些问题。
106 0
|
程序员
你做过代码 Review 吗?
Hello 大家好我是阿粉,代码 Review 相信大家一定不会陌生,但是真正在日常工作中能使用并且坚持执行下去的公司或者团队,阿粉觉得并不多,但是代码 Review 的好处大家都是有目共睹的,很多招聘岗位上面都有这样的要求,坚持执行代码 Review 对团队,对公司是很有好处的,特别是对写代码的同事!每个一起阅读代码的同事都会提出一些自己的建议 ,这些建议都是很宝贵的资源,往往都会有很大的收获。