A thought on code review


Code review was a scary concept for me in the beginning. After years of seeing bad codes coming back to haunt me, of fixing bugs causing by simple avoidable mistakes such as copy/paste mistake, I learned that code review is not only useful but only a must-have procedure for quality software development. Driven from that view, I made suggestions to management. It took awhile but eventually I’m grateful that management formed code review group  and I was selected to the group. Here are my thoughts on code review process. 

In order to have a good code review process, you must have a standard code guideline and a code review checklist:

  • a standard codign guideline: there are a lot of them on the internet. Just google them.
    Code convention includes
    code style (space/tab, brackets, comments…),
    naming convention (camel case or underscore for each word,  class/function/variable name prefixes if any…),
    standard coding practices (avoid goto, buffer overflow, dangling pointer,… )… 
    Notes: It should be customized to your organization to maximize effectiveness. 
  • a code review checklist: Not all code reviewers are created equal. Some are more detail or  thorough or senior than the others. This checklist standardizes the process and helps everyone review faster. It specially helps junior programmers learn coding better.
    Notes: It should be customized to your organization to maximize effectiveness. 
    Example:
    1/ Did programmer add comments per guideline?

    30/ Are newly added classes/functions neccessary? Can existing classes/functions be refactored to meet requirement?

Resources:

Funny blog on code review

Google code style guide

Advertisements
A thought on code review

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 )

Twitter picture

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

Facebook photo

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

Google+ photo

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

Connecting to %s