我开始做评论已经有几年了，但我经常看到一个函数或一个文件有很多行，以至于很难弄清楚它在做什么。
在这种情况下，第一眼无法判断是否编写了必要的处理，因此需要进行重构，因此我在以下步骤中进行了注释。
1. 要求解释谁在做什么
当代码本身很长时，实现它的人往往对这个过程的用途很模糊，所以我先要求解释一下。
如果解释不顺利，我们会问：“这就是你的意思吗？”
如果审稿人应该知道这一点，我会跳过这一步。
2.按说明划分功能
我让他们根据他们解释的内容考虑处理的统一性并将其转化为功能。
这时候就请你用函数名来解释一下处理内容。
我不觉得这里有很多误解，但有时会出现彼此为如何划分而烦恼的情况。
3.确保每个函数不要太长
同理，查看分割函数是否过长。
是回到1或2再重复的形象，但是如果你重复修正太多，执行方的精神面会耗尽，所以我尽量提前一点评论以免重复两次或三次。
4.检查每个功能的处理是否符合要求的规范
至此，我们终于处于可以检查所需规范和实现是否一致的状态。
当然，你应该能够在一定程度上掌握情况，但我们还是在这里做最后的确认。
概括
由于趋于冗长的代码往往是一系列的处理块，将其划分为函数，让它们按名称解释处理内容，使每个函数紧凑。
4是本来的目的，我想检查规范和实现是否匹配，但是如果代码很长且难以破译，检查本身很容易出错，所以一步步重构我正在尝试得到它。
原创声明：本文系作者授权爱码网发表，未经许可，不得转载;
原文地址：https://www.likecs.com/show-308626817.html