Sometimes we only take a look to the problem or to the system and we want to start programming right away, so we have a lot of problems later programming and debugging our code because we do not have like a process to review our code to the right way so this blog it’s about that and how to do a perfect Code Revision.
But first let me share a long video like an 1 hour but it’s really useful
One of the stages of the software development process is to review the code. For this stage there are so many techniques that can be useful to achieve that task. But you should consider the complexity of the system to select the best practice or the correct technique.
This time I will give you a general way to review the code done.
This technique involves 4 steps and 6 roles.
- Preparation – you determine inspection/review targets and the roles for each participant. Reading techniques should also be specified at this stage.
- Inspection – each inspector looks for defects according to their assigned role and perspective. In this stage, compiler warnings, static analysis tools, review tools, and defect tracking tools are put to use. These tools organize defects for the Rework stage
- Rework – is when reviewers go back and fix defects.
- Follow-up – where corrections are verified and reviewers make sure that new bugs haven’t been introduced. Defect tracking and review tools are used here too.
- Inspector: their goal is to detect and identify defects.
- Moderator: is responsible for leading the review group and keeping them focused on their goals. Moderators set up the environment and regulate the discussion and the time to keep reviews focused.
- Recorder: is responsible for documenting the issues that developers find.
- Author: the author is a developer who wrote the code being inspected. It is their responsibility to correct the defects once they are found.
- Organizer: the organizer develops a plan for development and review. They determine the time schedule for the inspection.
- Reader: explains the product being inspected/reviewed on behalf of the author.
The reading techniques are formed of simple questions that respond to the performance of the elements of the system.
Some IDE have different tools to track and analyse code. Depending of the platform you used to develop the system you should select one.
For more information check this links