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:

    Qld software sellers on trial for fraud  Deniliquin Pastoral Times
    Lawrence Township Trustees OK software upgrade  New Philadelphia Times Reporter

    Microsoft Great Plains Integrations ? Retail Management Sample

    Microsoft Business Solutions is emerging as very attractive vendor for... Read More

    Your Computer May Be Infected, Heres How To Check (NOT about virus)

    NOTE: Please take time to read on - it may... Read More

    Great Plains Dynamics/eEnterprise Upgrade ? Things to Consider and FAQ

    If you have Great Plains Dynamics/eEnterprise (version 6.0 or earlier)... 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

    Dont Choose Adobe When Working With PDF

    While Adobe is the most known maker of PDF tools,... Read More

    Microsoft Great Plains: Government & Non-Profit Organization ? Workflow Implementation

    Usually workflow & messaging is realized in CRM and then... Read More

    Free Software for Newbies and Web Developers

    Here is some free software tools to help you build... Read More

    Free Preventive Maintenance Software

    While several preventive maintenance software manufacturers offer free trials for... Read More

    Microsoft CRM Integration with Lotus Notes Domino: Messaging Connector ? Future Directions

    IBM Lotus Notes Domino and Microsoft CRM (Client Relation Management)... Read More

    Crystal Reports for Microsoft Great Plains

    Microsoft Business Solutions ? Great Plains is designed to meet... Read More

    How to Choose the BEST Charting Software

    I suggest that you do not spend a lot of... Read More

    Great Plains Dexterity Programming ? Overview For Developer

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

    S is for Spying, Surveillance -- and for Software as Well

    Words we choose to describe things and phenomena often show... Read More

    Spyware, Adware, etc. -- Terms and Common Sense

    When reading an article where some term is used often,... Read More

    Document Templates Give You The Perfect Framework For Your Documents

    When it comes to running an office, the SOHO entrepreneur... Read More

    Outlook... Not Just for Email! Using Your Outlook Calendar

    Microsoft Outlook is one of the most widely used software... Read More

    Microsoft CRM Customization Secrets ? Second Edition

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

    Microsoft Great Plains Integration with Legacy Systems ? Overview For Developer

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

    IT Strategy for Midsize Business: Microsoft vs. Java, Great Plains & CRM

    Midsize business or non-profit organization should decide if one-vendor solution... Read More

    Create A Flash Presentation For Free With Open Office

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

    Microsoft Great Plains, Navision, Axapta ? Selection Considerations

    During the years of our consulting practice, which comes back... Read More

    What You Must Know About Spyware Right Now

    Spyware is like the new technological nuclear weapon on the... Read More

    Troubleshoot Windows with Task Manager

    Task Manager is a Windows system utility that displays thetasks... Read More

    Microsoft CRM Integration with IBM Lotus Notes Domino ? Machinery Dealership Example

    IBM Lotus Notes with Domino email server is traditional document... Read More

    Internet Relay Chat - A Basic Introduction

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