Importance of Coding Standards

Programming Help for Beginners

We write programs to instruct computers. When programming using a high level programming language like C++ or Java, we are using a syntax that is somewhat closer to human languages. However, we use these programs as inputs to either compilers or interpreters to be converted to computer understandable binary format. For this reason, as far as the program code adheres to the syntax of the used programming languages, the compilers and interpreters never bother about the layout or visual formatting of the program code. However, as human programmers, we ourselves need to bother about the aesthetics of the program code.

What is a Coding Standard?

A coding standard is a set of guidelines, rules and regulations on how to write code. Usually a coding standard includes guide lines on how to name variables, how to indent the code, how to place parenthesis and keywords etc. The idea is to be consistent in programming so that, in case of multiple people working on the same code, it becomes easier for one to understand what others have done. Even for individual programmers, and especially for beginners, it becomes very important to adhere to a standard when writing the code. The idea is, when we look at our own code after some time, if we have followed a coding standard, it takes less time to understand or remember what we meant when we wrote some piece of code.

Coding Standards Make a Difference

Look at the following example:

int volume(int i, int j, int k) {
int vol;
vol = i * j * k;
return vol;
}

Looking at this code at a glance, it takes some time for one to understand that this function calculates the volume. However if we adhere to a naming convention for variables and method names, we could make the code more readable.

Here are few sample conventions:

  • use meaningful variable names
  • use verbs in method names
  • use nouns for variables
  • use 4 spaces to indent
  • int calculateVolume(int height, int width, int length) {
    int volume = 0;
    volume = height * width * length;
    return volume;
    }

    It takes more time to type this code, however this saves far more time. This code is far more readable than its original version. With a little bit of effort, we could make the code much more understandable.

    The Benefits

    It is not only the readability that we get through a coding standard in programming. Writing more secure code could also be encouraged through a coding convention. As an example, in C++ we could say that each pointer variable must be initialized to NULL.

    char* myName = NULL;

    This ensures that we would not corrupt memory while using this pointer variable.

    Code readability is just one of the aspects of maintainability. Coding standards help a great deal with program maintainability, our ability to change programs with ease. Consistency imposed through a coding standard is a key factor to achieve success in maintaining prorams.

    Defining Your Own Coding Standard

    A programmer can define his or her own coding convention and adhere to that in writing programms. However there are many coding conventions available on the Internet. Those who program in Java should have a look into http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html - Code Conventions for the Java Programming Language by Sun.

    For C++ coding standards, I would recommend that you have a look into http://www.bbc.co.uk/guidelines/webdev/AppB.Cpp_Coding_Standards.htm - C++ Coding Standards from BBC.

    http://oopweb.com/CPP/Documents/CPPHOWTO/Volume/C++Programming-HOWTO-14.html - C++ Programming HOWTO has some C++ Coding Conventions and also a bunch of links that lead to several coding standards that you can pick from.

    John Dirk
    Programming Consultant
    http://www.programminghelp4u.com/
    Programming ( Assignment / Project ) Help

    In The News:


    pen paper and inkwell


    cat break through


    New Web-Based HR Tool is Max From NAS, Hannibal, and InfoLink

    Three highly respected names in Human Resources have joined forces... Read More

    Microsoft Blues

    With the advent of 'Service Pack 2' for Windows XP... Read More

    Microsoft Great Plains Integration with Legacy Systems ? Overview For Developer

    Looks like Microsoft Great Plains becomes more and more popular,... Read More

    Microsoft Great Plains on Ctree or Pervasive SQL ? What to Do ? Tips for IT Manager

    As you probably know, when Microsoft purchased Great Plains Software... Read More

    Putting Screensavers Under Control

    No matter how much you enjoy your favorite screensavers, sometimes... Read More

    Navision Sales Module & Reporting: Jet Reports, C/ODBC, XBRL, Business Analytics ? highlights

    Microsoft bought Navision, Denmark based software development company, along with... Read More

    Rapid Application Development - Is it Really a Need of Today?

    Rapid Application Development (RAD) is a software development methodology. In... Read More

    Microsoft CRM Programming Secrets ? Tips For Developers

    This article is for advanced Microsoft CRM SDK C# developers.... Read More

    Microsoft RMS Customization ? PO Items Receiving in Great Plains

    Microsoft Retail Management (RMS) and Microsoft Great Plains are retail... Read More

    How To Choose A Fire Wall Software Program

    In the real world a "fire wall" is a fireproof... Read More

    Internet Relay Chat - A Basic Introduction

    What is IRC?IRC is Internet Relay Chat. It is a... Read More

    Groupware: Answers the 5 Questions of Document Collaboration

    Every organization which creates collaborative documents, whether they are budgets,... Read More

    Microsoft CRM Integration & Customization: SharePoint Document Gateway

    MS CRM is very close to document workflow automation, including... Read More

    Microsoft Navision Customization and Reporting ? Tips For Programmer/IT Specialist

    C/SIDE (Client/Server Integrated Development Environment) - The core of... Read More

    Causes of ERP Failures

    ERP is the acronym of Enterprise Resource Planning. Multi-module ERP... Read More

    5 Mac Security Tips You Can?t Live Without

    So, you've bought a new Macintosh, and now you may... Read More

    How to Tell You Have Spyware, Ad-ware or Viruses

    Usually, the easiest way to tell you have spyware is... Read More

    Data Quality Best Practices for Salesforce.com

    Executive SummaryAn effective plan for entering, cleaning and updating the... Read More

    Best Practices In Choosing Network Monitoring Software

    Blue Cross and Blue Shield of Hawaii (HMSA) found itself... Read More

    Three Steps To Windows Safety Heaven

    Now there are Three Steps To Heaven Just listen and... Read More

    7 Things to Consider Before Buying Small Business Accounting Software

    The world of small business accounting software can be a... Read More

    Hubris - Definition: Microsofts Passport

    Before September of 1995, Microsoft ignored the Internet because their... Read More

    Reduce Pop-ups and Annoying Ads

    There is many things more frustrating than surfing a website... Read More

    Microsoft Small Business Manager eCommerce ? Overview

    Microsoft Business Solutions Small Business Manager is scaled down Great... Read More

    Microsoft Great Plains Implementation for Midsize & Large Corporation: Lockbox Processing

    Microsoft Great Plains is now targeting large and midsize businesses... Read More

    Microsoft CRM Integration With Microsoft Office Documents ? Overview For System Integrator

    Microsoft CRM is CRM application, maintained and supported by Microsoft... Read More

    How to Make Own CMS

    Every day millions of new web documents emerge on the... Read More

    Microsoft Great Plains: carpet, textile, fabric, felt distributor ? implementation overview

    In this small article we will show you the possible... Read More

    Razzle Dazzle Them

    Once upon a time not so long ago, there was... Read More

    Does Microsoft have any real competition?

    Does Microsoft Have any Real Competition? Copyright (c) 2003 Gregory... Read More

    Corporate ERP: Microsoft Great Plains For The Plant In Brazil ? Overview For CIO

    Microsoft Business Solutions Great Plains as new ERP for multinational... Read More

    Defining OLAP Solutions and Data Warehouse design

    This tutorial covers OLAP solutions used by Data warehouses and... Read More

    Create A Flash Presentation For Free With Open Office

    The intentions of this short tutorial are not to teach... Read More