Introduction to Software Coding Standards
Read: 2092 times    -     Avarage Rate: 4.2





2010 23 Mar

Introduction

When I was looking for a standard convention for generics, I came across a 50-page manual for coding standards for C#. I am sure that, apart from the author, there are few who actually go through and read all of them. So, I thought of coming up with this article. I have tried to comprehend the essential facts which we developers sometimes neglect in C#. I will also discuss some common pitfalls. Small, sweet and simple. That’s how I describe it. I hope you enjoy reading.

Why Coding Standards

Simple: maintainability. If, 6 months down the line, your customer isn’t too happy with the product and wants an enhancement in the application you have created, you should be able to do it without introducing new bugs. There are a lot of other good reasons, but this is the one which concerns us more than anything else. Not following any standard is like going with a temporary solution (which might lead to a permanent problem) and, as you will see, it takes less effort to keep in mind a few simple measures than to do haphazard coding. All you have to do is study good standards once and keep them in the back of your head. Trust me; it’s worth it.

Contents

  • 1.Naming – What is meant by meaningful names
  • 2.Casing – When to use PascalCase and when camelCase
  • 3.Additional Remarks – Common Pitfalls – Mistakes we should watch out for

 

I'll go more into details for each of that points soon, keep checking the blog for additional information.

Comments