Code Review – Guidelines

I’ve taken on a new role for a software project based on Embarcadero Delphi code, that of Code Reviewer.

I’m a C++ programmer and have little experience with actually writing or debugging Delphi code.

So does that mean that I am the wrong man for the job?

Here are two things I won’t be doing:

I won’t be testing the code by running it (other people in the development team will be doing this alongside the original testing done by each other programmer as he/she develops the code).

I won’t be looking for syntax errors. The code should compile and run before it is passed to the code reviewer.

So what will I be doing?

I will be looking at the overall method used to perform the functions. Is it a sensible algorithm? Are looping structures sensibly implemented?
I will be looking at the choice of names used for variables, procedures and functions (there are plenty of blog postings about this here!).

I will be looking at comments, particularly any lengthy text that summarises the tasks achieved by the code to try to ensure that they are clear and simply written yet are accurate and complete and not open to misinterpretation. I will also check that they actually exist at the top of each source code file.

Whilst doing so I will be careful to be positive and respectful to my fellow team members. In particular for many, English (the language used for the code and comments) may not be the native language of some of the team members so any grammar / spelling or improvements to accuracy or coherency of explanation will be done in a sensitive manner.

That’s my aim.

If you consider these items you realise that in depth experience with Delphi is not a prerequisite to achieving the aims. In fact it may be argued that a lack of in depth expertise may even be useful!

Leave a Reply

Please log in using one of these methods to post your comment:

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