Code revision

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.

Steps:

  1. Preparation – you determine inspection/review targets and the roles for each participant. Reading techniques should also be specified at this stage.
  2. 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
  3. Rework – is when reviewers go back and fix defects.
  4. 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.

Roles:

  1. Inspector: their goal is to detect and identify defects.
  2. 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.
  3. Recorder: is responsible for documenting the issues that developers find.
  4. Author: the author is a developer who wrote the code being inspected. It is their responsibility to correct the defects once they are found.
  5. Organizer: the organizer develops a plan for development and review. They determine the time schedule for the inspection.
  6. 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.

References:

Mitch Pronschinske. (2010). Code Review Tools and Techniques. april of 2019, de DZone Sitio web: https://dzone.com/articles/code-review-tools-and

https://smartbear.com/learn/code-review/best-practices-for-peer-code-review/

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s