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


    Microsoft CRM Customization Secrets ? Second Edition

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

    Builders Beware

    Which Type of Shop Can Rely On A Home Built... Read More

    Create A Flash Presentation For Free With Open Office

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

    Microsoft CRM Development

    Microsoft CRM is CRM answer from Microsoft Business Solutions.The whole... Read More

    Software Engineering: An Introduction

    Software Engineering is the Systematic Approach for analysis design implementation... Read More

    How to Choose the BEST Charting Software

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

    QuarkXpress Tips: How to Move Content Between Print and Web Layouts

    Since its release in 1987, QuarkXpress had made an immediate... Read More

    Device Driver Basics

    Most people understand that the "hardware" part of their computer... Read More

    Chinese Input - Step by Step Instruction on How to Input Chinese Characters in English Windows XP

    Enabling Chinese input is quick and easy, there are only... Read More

    Microsoft Great Plains FA: Fixed Assets ? Overview For Consultant

    Great Plains Fixed Assets Management module is a robust tool... Read More

    Intro to UNIX Shells

    A UNIX Shell is in simplest terms, a command line... Read More

    Free Software - Powerful Alternatives to Budget-Busting Software

    When you buy a computer, it most likely comes with... Read More

    Microsoft Great Plains Integrations - Tips for Developer

    In this short FAQ style article we would like to... Read More

    Screenshots Vista Windows

    Features Additionally, Vista will include many other new features.Aero Vista... Read More

    Algebra Help Software

    Need help making sense of algebra? Have algebra lectures in... Read More

    Fast Car Knoppix

    Small can be beautiful! Working with Knoppix for the past... Read More

    Cisco Certification: Introduction To ISDN, Part IV

    In part III of this ISDN primer, we learned that... Read More

    Removing Incoming Email in MS Exchange, C# Example

    The purpose of one of our projects was MS Exchange... Read More

    Industry Experts Answer the One Million-dollar Question - Why Genie Backup Manager?

    Many reasons made GBM a unanimous choice for experts, one... Read More

    eConnect: eCommerce Development for Microsoft Great Plains

    Microsoft Business Solutions Great Plains has several options to enable... Read More

    Put Some Pizazz in Your Software Arsenal

    The software giants don't do everything and don't always produce... Read More

    Software Piracy - Global Increase

    Pirated software is on the increase and now accounts for... Read More

    Pros and Cons of Using FREE Software in Your Business

    Itâ??s easy to understand why you might be drawn to... Read More

    SSH (SCP) Send Files from Windows to Your Linux Box

    Not all of us have the luxury of working both... Read More

    Putting Screensavers Under Control

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

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

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

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

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

    Did You Ever Want to Completely Erase Everything on Your Computer?

    Did you ever want to erase everything on your computer?... Read More

    Anti-Virus Software

    Anti-virus software is used to find, remove or fix files... Read More

    SQL Administrator Skills Required to Support Microsoft Great Plains

    Microsoft Great Plains is becoming more and more popular and... Read More

    Microsoft Business Solutions Partner ? How to Launch New IT Consulting Practice

    In the new era of internet marketing the problem of... Read More

    Microsoft Navision Database Selection: C/SIDE or MS SQL Server - Overview For IT Specialist

    There are certain pluses and minuses in both cases and... Read More

    Microsoft CRM ? Typical Customizations

    Microsoft CRM was designed to be easily customizable. Microsoft CRM... Read More