C# Coding Guidelines

This document describes how you should format your code and what naming conventions you should use. There are two main areas to target with this;

1. Coding style, formatting and naming of private variables.
2. Following the .Net coding guidelines concerning design rules, naming rules for public types, classes and namespaces and complying with the .Net security rules. To help you follow these rules we will use a plug in to Visual Studio based on Microsoft FxCop.

Why using code conventions?

Code conventions are important to programmers for a number of reasons:

• 80% of the lifetime cost of a piece of software goes to maintenance.
• Hardly any software is maintained for its whole life by the original author.
• Code conventions improve the readability of the software, allowing engineers to understand new code more quickly and thoroughly.
• If you ship your source code as a product, you need to make sure it is as well packaged and clean as any other product you create.

Note: For the conventions to work, every person writing software must conform to the code conventions. Everyone.

Contents

• Source Files
• Code Indentation
• Comments
• Declarations
• Statements
• Naming Conventions
• Special IFS Naming Rules
• Programming Practices