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 Retail Management System (RMS) SQL Customization ? Overview for Programmer

    Microsoft Retail Management System serves retail single store as well... Read More

    What is Spyware? Are You Being Watched?

    Find out why Spyware Removal from computers is important and... Read More

    The Hidden Power of Online Manual

    Writing software manuals is boring, isn't it? We often think:... Read More

    Microsoft Great Plains Furniture & Fixtures ? Implementation & Customization Highlights

    Microsoft Great Plains, former Great Plains Software Dynamics / eEnterprise... Read More

    Microsoft Great Plains Logistics & Warehouse Management ? Implementation & Customization Highlights

    Logistics automation is often considered as barcoding extension to Sales... Read More

    Microsoft Great Plains eCommerce: overview for developer

    Microsoft Business Solutions Great Plains was designed back in the... Read More

    10 Ways to Learn a Software

    Following tips help you to learn a software in lesser... 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

    Microsoft Great Plains Upgrade ? Things to Consider and FAQ

    If you have Microsoft Great Plains and support it for... Read More

    Quick Summary of Basic and Common Linux Commands

    There are many commands that are used in linux on... Read More

    Run Your Own Search Engine

    Our hosted solution allow you to run your own search... Read More

    Groove Network. Are you in it?

    If you are in a business that passes documents around... Read More

    The Importance of Timely Timesheets

    Whether you are a small consultancy firm, a medium sized... Read More

    Passwords Used In Microsoft Word Documents

    You would like to protect your documents, wouldn't you? Reasons... Read More

    Microsoft Great Plains Reporting ? Overview for Developer

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

    Microsoft Great Plains Customization Recovery & Upgrade for Large Corporation

    At the end of XX century, in the late 1990th... Read More

    Exactly What Does FTP Stand for and What Can it do for Me?

    FTP stands for "file transfer protocol". FTP is basically a... Read More

    The Top 5 Wrong Reasons For Not Hiring Testers

    Considering whether or not your software company should hire a... Read More

    Windows x: Basic Windows ?Security? Issues

    Language development computer: Computer-based method for aiding language development seems... Read More

    Microsoft Great Plains SOP: Sales Order Processing

    Microsoft Business Solutions Great Plains is marketed for mid-size companies... Read More

    Microsoft CRM Implementation for Large Corporation ? overview

    Microsoft Business Solutions CRM is now approaching the phase of... Read More

    Microsoft CRM Integration with Microsoft Retail Management System (RMS) ? Overview

    Microsoft Client Relation Management system (Microsoft CRM) and Microsoft RMS... Read More

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

    In this small article we will show you the possible... 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

    Does Microsoft have any real competition?

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

    SQL scripts for Project Accounting: Microsoft Great Plains series ? overview for developer

    Microsoft Business Solutions Great Plains has Project Accounting module where... Read More

    Microsoft Great Plains - Typical Problems And Fixes ? Overview For IT Administrators

    How to delete the user? This is the first problem... Read More

    Microsoft Great Plains Customization and Development ? Overview for Programmer

    When Great Plains Software was designing and developing Great Plains... Read More

    Removing Incoming Email in MS Exchange, C# Example

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

    Document Templates Give You The Perfect Framework For Your Documents

    When it comes to running an office, the SOHO entrepreneur... 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

    Anti-Spyware Protection ? Holes in the Shining Armor

    Looking at all the ads which promise to get rid... Read More

    Microsoft CRM for Corporate Business ? Working Offline

    If your company has regional and worldwide operations, you might... Read More