View source for Coding guideline - Common rules

== Introduction ==

This document aims at giving common rules that developers MUST follow to ensure not only consistency in the whole application but also the ease of code reading and maintaining. Due to the fact that we are working mainly on C# language, all examples will be given in this language only. 

Please refer to the .NET Framework Design Guidelines (http://msdn.microsoft.com/en-us/library/czefa0ke.aspx) for a complete set of guidelines suggested by Microsoft. 

== Terms and Conventions ==

=== Naming Terms ===

There are 3 terms used for naming files, class names, variable names, etc. All are listed in this section. 

'''Pascal case''' 

The first letter in the identifier and the first letter of each subsequent concatenated word are capitalized. You can use Pascal case for identifiers of three or more characters. 

For example: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#2b91af">CatGlobeImageButton</font>, <font color="#2b91af">LanguageEditor</font> </font> 

'''Camel case''' 

The first letter of an identifier is lowercase and the first letter of each subsequent concatenated word is capitalized. 

For example: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#2b91af">resourceId</font>, <font color="#2b91af">resourceTemplateId</font> </font> 

'''Uppercase''' All letters in the identifier are capitalized. Use this convention only for identifiers that consist of two or fewer letters. 

For example: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#2b91af">ID</font>, <font color="#2b91af">UI</font>, <font color="#2b91af">IO</font> </font> 

== Style Guidelines ==

=== File Organization ===

'''Location ''' 

*Class file should be put in directory whose path follows class's namespace. This makes finding a class easier.

For example: code file of class <font face="Courier New, monospace" size="2" color="#2b91af" style="font-size: 9pt;">''CatGlobe.Web.UI.WebControls.CatGlobeImageButton''</font> should be found in side <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">“''{CODE_BASE}\CatGlobe\Web\UI\WebControls''”</font> 

'''Naming ''' 

*Always use ''Pascal'' for naming code file. 
*Source files should be given the name of the first public class in the file plus “.cs”. The purpose of this naming is clear, it increases the consistent of organization and also the maintainability.

For example: code file <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">“''{CODE_BASE}\CatGlobe\Web\UI\WebControls\CatGlobeImageButton.cs''”</font> should have the first public class as <font face="Courier New, monospace" size="2" color="#2b91af" style="font-size: 9pt;">''CatGlobeImageButton''</font> 

'''Content''' 

*There should be only one <font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">namespace</font> declaration in one code file only. 
*One source file should contain only one public class/interface/enum, although multiple internal classes are allowed. Delegates and Interfaces are allowed to be put in the same file as class/interface/enum.

''<u>Should</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
<source lang="csharp">
    public sealed class CatTask : PersistentObject, ICatTaskClientObject, IComparable 
    {
        private sealed class CatTasksAccess : AccessBase 
        { 
        } 
    } 
</source>

''<u>Should not</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
<source lang="csharp">
    public sealed class CatTask : PersistentObject, ICatTaskClientObject, IComparable 
    { 
    } 

    [Serializable] 
    public sealed class StringConstant 
    { 
    } 
</source>

*Classes member should be grouped into sections (Fields, Constructors, Properties, Events, Methods, Private interface implementations, Nested types). And there should be a region name in <font color="#0047ff">''#endregion''</font> instructive although it is not required. Regions can be shown/hide while viewing with VS thus increasing the readability.

For example: 
<source lang="csharp">
    public sealed class CatTask : PersistentObject, ICatTaskClientObject, IComparable 
    {
        #region AccessClass 

        private sealed class CatTasksAccess : AccessBase 
        { 
        } 

        #endregion AccessClass 

        #region Private Instance Fields 

        private int resourceId; 
        private int resourceTemplateId; 

        #endregion Private Instance Fields 
    } 
</source>

''<u>A propose class file with regions:</u>'' 
<source lang="csharp">
    public class SampleClass 
    {
        #region Nested Enums, Structs, and Classes 
        #endregion Nested Enums, Structs, and Classes 

        #region Constructors & Finalizers 
        #endregion Constructors & Finalizers 

        #region Member variables 
        #endregion Member variables 

        #region roperties 
        #endregion Properties 

        #region Methods 
        #endregion Methods 
    } 
</source>

*There should not be more than ''<u>500 lines of code</u>'' inside one file. Files containing more than 500 lines have less readability than the ones with less than 500 lines. There is one exception that we should not take into account on this rules, that are auto-generated files since most of the time we do not maintain these files directly. 
*Each line of code ''<u>should not exceed 120 characters</u>''. Lines with more than 120 characters normally require code viewer using the horizontal scrollbar thus decrease readability.

=== Tabs, Indenting, Spacing and Bracing ===

'''Tabs and Indenting''' 

*Tab characters (\0x09) '''MUST NOT''' be used in code. All tabs must be replaced by 3 space characters. 
*All indentation '''MUST''' be done with '''''3 space characters'''''.

'''Spacing''' Spaces improve readability by decreasing code density. Here are some guidelines for the use of space characters within code: 

*'''Do''' use a single space after a comma between function arguments.

:Right:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">Console.In.Read(myChar,0,1);</font> 
:Wrong: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">Console.In.Read(myChar,0,1);</font>

*'''Do not''' use a space after the parenthesis and function arguments.

:Right: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">CreateFoo(myChar, 0, 1);</font> 
:Wrong: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">CreateFoo(<span style="background: rgb(255, 0, 0) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"> </span>myChar, 0, 1<span style="background: rgb(255, 0, 0) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"> </span>)</font>

*'''Do not'''''use spaces between a function name and parenthesis.''

:Right: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">CreateFoo(); </font> 
:Wrong: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">CreateFoo<span style="background: rgb(255, 0, 0) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"> </span>()</font>

*'''Do not'''''use spaces inside brackets.''

:Right: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">x = dataArray[index];</font> 
:Wrong: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">x = dataArray[<span style="background: rgb(255, 0, 0) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"> </span>index<span style="background: rgb(255, 0, 0) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"> </span>]; </font>

*'''Do''' use a single space before flow control statements.

:Right: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">while<span style="background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"> </span>(x == y)</font> 
:Wrong: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">while(x==y)</font>

*'''Do''' use a single space before and after comparison operators.

:Right: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">if (x<span style="background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"> </span>==<span style="background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;"> </span>y)</font> 
:Wrong: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">if (x==y)</font>

'''Bracing''' 

*Open braces must always be at the beginning of the line after the statement that begins the block. This increases readability of code.

''<u>Must:</u>'' 
<source lang="csharp">
    if ((CatTaskStatus.Status == CatTaskCommon.CatTaskStatus.Failed) 
    {
        CatTaskCompleted ctc = CatTaskCompleted.GetByLatestCompletedDate(this); 
        if (ctc != null)
            completedDate = ctc.CompletedDate; 

        return completedDate; 
    } 
    else 
    {
        ... 
    } 
</source>

''<u>Must not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
<source lang="csharp">
    if ((CatTaskStatus.Status == CatTaskCommon.CatTaskStatus.Failed) { => Wrong brace location
        CatTaskCompleted ctc = CatTaskCompleted.GetByLatestCompletedDate(this); 
        if (ctc != null) {
            completedDate = ctc.CompletedDate; 
        } 
        return completedDate; 
    } 
</source>

*For anonymous methods and lambda expressions, the braces must be indent at the same level with its declaration.

''<u>Example:</u>'' 
<source lang="csharp">
    private  SampleDelegate _mySampleDelegate = delegate()
                                                { 
                                                }; 

    private SampleDelegate _mySampleDelegate = (name) =>
                                               { 
                                               }; 
</source>

*Must not put block that contains more than 2 statements in the same line:

''<u>Must not</u>'': 
<source lang="csharp">
if  (ctc != null) {completedDate = ctc.CompletedDate; return completedDate; }
</source>

*With single statement blocks, using of braces is optionnal. It is encourage to not use the braces to save number of line of code.

''<u>Should:</u>'' 
<source lang="csharp">
    if  (ctc != null)
        completedDate = ctc.CompletedDate; 
</source>

''<u>Should not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
<source lang="csharp">
    if  (ctc != null) 
    {
        completedDate = ctc.CompletedDate; => 3 lines of code do the same as 1 line 
    } 
</source>

*There are exceptions that brace should be placed on the same line as the keyword that requires braces.

''<u>One statement code block:</u>'' 
<source lang="csharp">
    public int  CompletedMailTemplateId 
    {
        get { return completedMailTemplateId; } => It is much nicer than having 4 lines of code 
        set { completedMailTemplateId = value; } 
    } 
</source>

''<u>.NET 3.0 property syntax:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
<source lang="csharp">
    public int MyProperty { get; set; }
</source>


<div style="border: 1pt solid rgb(0, 0, 0); padding: 5px; background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial; color: rgb(0, 0, 255);">
'''Tips:''' <br> All rules in this section can be applied automatically by applying a common ''Visual Studio settings file''. Developers just have to remember to apply these rules by pressing ''Ctrl + K + D'' (under default installation) or ''Ctrl + E + C ''using Resharper before committing. 
</div>

=== Commenting  ===

Comments should be used to describe intention, algorithmic overview, and/or logical flow. It would be ideal, if from reading the comments alone, someone other than the author could understand a function’s intended behavior and general operation. While there are no minimum comment requirements and certainly some very small routines need no commenting at all, it is hoped that most routines will have comments reflecting the programmer’s intent and approach. 

*Use <font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;">//</font> or <font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;">///</font> for commenting but not <font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;">/* ... */</font>. The last comment style is out of date, it is useful in the old time when coder wanted to comment a large block of code. Using such comment will save a lot of time as writing <font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;">//</font> on each line. However, with new editor, comment/uncomment block of code is just a matter of selecting the block and calling a short cut key. 
*Do not decorate your comment with special charaters.

''<u>Must not:</u>'' <font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;"></font> 

:<font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;">// *********************************</font> 
:<font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;">// Comments block</font> 
:<font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;">// **********************************</font>

<font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;"></font> 

*Avoid comments that explain the obvious. Code should be self-explanatory. Good code with readable variable and method names should not require comments.

''<u>Should not</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#808080">&lt;summary&gt;</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#008000">Resource Id</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#808080">&lt;/summary&gt;</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">int </font>resourceId;</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

:<font color="#ff0000">=&gt; Comment that makes no sense. Could be something like: &lt;''The primary id of the &lt;see cref=”CatGlobe.Domain.Common.Resource” /&gt; that this class is working with.''</font>

*Include Task-List keywords flags to enable comment-filtering. These comment can be tracked by using Visual Studio Task List window or just simply by searching.

''<u>Example:</u>'' <font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;"></font> 

:<font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;">// TODO: Fix this</font> 
:<font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;">// HACK: work-around temporarily while waiting for better solution</font> 
:<font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;">// UNDONE: Will be done in version xxxx</font>

<font face="Courier New, monospace" size="2" color="#008000" style="font-size: 9pt;"></font> 
<div style="border: 1pt solid rgb(0, 0, 0); padding: 5px; background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;">
<font color="#0000ff">'''Tips:'''</font> <br> <font color="#0000ff">In Visual Studio, more keywords can be defined in Tools <font face="Times New Roman, serif">→</font> Environment → Task List. More detail description can be found here http://msdn.microsoft.com/en-us/library/zce12xx2(VS.80).aspx </font> 
</div> 
*Always apply C# comment-blocks (///) to public, protected and internal declaration. The comment will be displayed as tooltip in editor and this helps method's user a lot for writing code correctly.

See picture below: [[Image:Coding Guidelines Common rules 1.0 html m698f2609.png|thumb|center|500px|Class comment displayed inside help text]] 

<br> 

*Use comment tags whenever possible, this could give very much help on generating help files. The most used tags are: <font color="#33cc66"><font face="Courier New, monospace">&lt;summary&gt;, &lt;param&gt;, &lt;paramref&gt;, &lt;return&gt;, &lt;exception&gt;, &lt;see&gt;, &lt;seeAlso&gt;</font></font>.

''<u>Class comment:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#808080">&lt;summary&gt;</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#008000">This is my sample class for illustating comment on coding guide line document</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#808080">&lt;/summary&gt;</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af">SampleClass</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

''<u>Method comment:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#808080">&lt;summary&gt;</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#008000">This is my test method. </font><font color="#008000">It is created for demonstrating how to write comment for</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#008000">a method.</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#808080">&lt;/summary&gt;</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#808080">&lt;param name="arg1"&gt;</font><font color="#008000">This is sample argument 1. It will be used for ... </font><font color="#808080">&lt;/param&gt;</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#808080">&lt;param name="arg2"&gt;</font><font color="#008000">This is sample argument 2. It will be used for ...</font><font color="#808080">&lt;/param&gt;</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#808080">&lt;returns&gt;</font><font color="#008000">Return the result string.</font><font color="#808080">&lt;/returns&gt;</font></font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">protected </font><font color="#0000ff">string </font> MyMethod(<font color="#0000ff">string </font> arg1, <font color="#0000ff">string </font> arg2)</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 
<div style="border: 1pt solid rgb(0, 0, 0); padding: 5px; background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial; color: rgb(0, 0, 255);">
'''Tips:''' <br> In Visual Studio, typing three slashes on the line right before a declaration will automatically create a template for comment on the correspondence element. 

An explaination on the comment can be found here: http://msdn.microsoft.com/en-us/magazine/cc302121.aspx 

A detail explaination of all comment tags can be found here: http://thoughtpad.net/alan-dean/cs-xml-documentation. 
</div> 
=== Naming ===

==== Common rules ====

*Always use Camel Case or Pascal Case for naming. With private instance member, prefix variable name with an underscore '_'.

''<u>Pascal case for types (classes/interfaces/delegates/enums/structs) and methods:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af"><u>SomeClass</u></font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">void </font><u>SomeMethod</u>() { }</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

''<u>Camel case for member variables and parameters:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public void </font>MyMethod(<font color="#0000ff">int </font><u>someNumber</u>)</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">int </font>''_number'';</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

''<u>Camel case preceding by an underscore '_' for private/protected fields:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af"><u>SomeClass</u></font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">int </font>''_number'';</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">protected </font><font color="#0000ff">string </font>''_name'';</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

''<u>Pascal case for enum's values:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">enum</font><font color="#2b91af">CodeReviewResult</font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">None,</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">Approval,</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">PartialDisapproval,</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">CompleteDisapproval,</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">NeedRework,</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

*Must use Upper Case for naming constant and separate words with underscore character '_'

''<u>Example:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public const int </font>DATABASE_CONNECTION_TIMEOUT = 500;</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

*Should not create namespaces, classes, methods, properties, fields, or parameters that vary only by capitalization.

''<u>Should not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">void </font>MyMethod(<font color="#0000ff">string </font><font color="#ff0000">arg1</font>, <font color="#0000ff">string </font><font color="#ff0000">Arg1</font>)</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

*Should not use names that begin with numeric characters. 
*Should not use single char variable names, except in <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">'''For/While'''</font> loop. 
*Always choose meaningful and specific names. 
*Should not use abbreviations unless the full name is excessive (over 20 characters). With Visual Studio IDE's IntelliSense, it is very easy finding a variable no matter how long the name is.

''<u>Should not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#2b91af">List</font>&lt;<font color="#0000ff">string</font>&gt; UDFList;</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

:<font color="#ff0000">=&gt; this stands for User Defined list, the name hide the purpose of the owner variable from code reader</font>

==== Namespace naming ====

The general rule for naming namespaces is to use the company name followed by the technology name and optionally the feature and design. 

''<u>Example:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">namespace</font> CatGlobe.DiffStat.Console;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">namespace</font> CatGlobe.DiffStat.WinApp;</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

==== Type naming ====

*Use noun or pronoun for naming classes/interfaces.

''<u>Should not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af"><u>Run</u></font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

''<u>Should:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af"><u>Runner</u></font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

*MUST prefix an interface with character <font color="#ff0000"><font face="Courier New, monospace">I</font></font>.

''<u>Example:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">int erface </font><font color="#ff0000">I</font><font color="#2b91af">SomeInterface</font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

*MUST suffix custom attribute classes with <font color="#ff0000"><font face="Courier New, monospace">Attribute</font></font>.

''<u>Example:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af">MyCustomAttribute</font>: System.<font color="#2b91af">Attribute</font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

*MUST suffix custom exeptions classes with <font color="#ff0000"><font face="Courier New, monospace">Exeption</font></font>.

''<u>Example:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af">My</font><font color="#2b91af">Exception</font>: System.<font color="#2b91af">Exception</font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

*MUST NOT suffix any enums with <font color="#ff0000"><font face="Courier New, monospace">Enum</font></font>.

''<u>Must not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">enum </font><font color="#2b91af">ResourceType</font><font color="#ff0000">Enum</font><font color="#2b91af"></font><font color="#ff0000"><font face="Arial, sans-serif">=&gt; it is better if Enum is removed</font></font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

==== Method and Property naming ====

*Use a verb-object pair for naming methods.

''<u>Example:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">void </font><u>Test</u>CatTask();</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">void </font><u>Get</u>Name();</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

*If returned type is Boolean, try to prefix method name with “Can”, “Is” or “Has”.

''<u>Example:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">bool </font><u>Can</u>Save()</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">bool </font><u>Is</u>Editable()</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">bool </font><u>Has</u>Access()</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

*Never perfix a property name with “Get”, “Set”. It is because when using value of a property it is already understand as calling to a “Get” method.

''<u>Must not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">int </font><font color="#ff0000">Get</font>IntValue { <font color="#0000ff">get</font>; <font color="#0000ff">set</font>; }</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

''<u>Must:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">int </font>IntValue { <font color="#0000ff">get</font>; <font color="#0000ff">set</font>; }</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

==== Generic types naming ====

*Should use single capital letters for generic types.

''<u>Should:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af">List</font>&lt;'''T'''&gt;<font color="#0000ff">where </font>'''T''' : <font color="#0000ff">string </font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

=== Code organization ===

==== <font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">using</font> Statement ====

*All <font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">using</font> statements should be put outside any namespaces statements.

''<u>Should:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>CatGlobe.Web.UI.WebControls;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>CatGlobe.Web.Common.ClassBase;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>CatGlobe.Web.Common.ServerMethods;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>CatGlobe.Domain.SiteVisitor.ServiceHandler;</font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">namespace </font>CatGlobe.Web.Common.Resources.List;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

''<u>Should not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">namespace </font>CatGlobe.Web.Common.Resources.List</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>CatGlobe.Web.UI.WebControls;</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>CatGlobe.Web.Common.ClassBase;</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>CatGlobe.Web.Common.ServerMethods;</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>CatGlobe.Domain.SiteVisitor.ServiceHandler;</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

*Related <font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">using</font> statements should be group together. This helps reader an overview of which library will be used in the remaining code.

''<u>Example:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>System;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>System.Xml;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>System.IO;</font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>Infragistics.WebUI.UltraWebGrid; <font face="Arial, sans-serif" color="#ff0000">=&gt; Reference Infragistics</font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>Infragistics.WebUI.UltraWebNavigator;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>Infragistics.WebUI.UltraWebToolbar;</font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>CatGlobe.DataAccess;<font face="Arial, sans-serif" color="#ff0000">=&gt; Reference CatGlobe's DataAccess</font></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>CatGlobe.Framework.GroupBuilder; <font face="Arial, sans-serif" color="#ff0000">=&gt; Reference CatGlobe's Framework</font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>CatGlobe.Framework.Resources;</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

==== Internal Types ====

*Types that are declared inside a class must be group together. And the group must be put right after class definition.

''<u>Example:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af">ResourceList</font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">#region </font>Types</font>

::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#808080">&lt;summary&gt;</font></font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#008000">Collection of </font><font color="#808080">&lt;seecref="CatGlobe.Domain.Common.Resource"/&gt;</font><font color="#008000">s,</font></font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#008000">in which we can sort the whole list or </font></font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#008000">fetch resources based on some criteria.</font></font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#808080">&lt;/summary&gt;</font></font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">class </font><font color="#2b91af">ResourceCollection</font></font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#808080">&lt;summary&gt;</font></font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#008000">Provide methods for Save/Delete a single </font><font color="#808080">&lt;seecref="CatGlobe.Domain.Common.Resource"/&gt;</font></font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#008000">or collection of </font><font color="#808080">&lt;see cref="CatGlobe.Domain.Common.Resource"/&gt;</font><font color="#008000">s.</font></font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#808080">/// </font><font color="#808080">&lt;/summary&gt;</font></font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">class </font><font color="#2b91af">ResourceHandler</font></font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">#endregion </font>Types</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

==== Member and Local Variables ====

*All class's member variable must be put at top of class (after internal types declaration). This increase readability of code, since at the first look the viewer can tell what are members of class and also theirs types.

*Each variable of different types must be declared on different lines.

''<u>Must:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">string </font>_sampleString;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">int </font>_sampleInt;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">long </font>_sampleLong1, _sampleLong2, _sampleLong3;</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

''<u>Must not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">string </font>_sampleString;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">int </font>_sampleInt;</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

*Local variables must be clared as close as possible to its first use and must be in the same code block that use it.

==== Methods ====

*A method must not exceed 100 lines. Methods with more than 100 lines usually decrease readability and thus maintainability.

*Methods that relate to each others by any means should be grouped together.

''<u>Example:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">#region </font>Database Access Methods</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">#endregion </font>Database Access Methods</font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">#region </font>Private Utility Methods</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">#endregion </font>Private Utility Methods</font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">#region </font>Serialization Methods</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">#endregion </font>Serialization Methods</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

*Interface implementations must be grouped together.

''<u>Example:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">interface </font><font color="#2b91af">ISample</font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">void </font>SampleMethod();</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af">SampleImplementation</font>: <font color="#2b91af">ISample</font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">#region </font>ISample Members</font>

::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">void </font><font color="#2b91af">ISample</font>.SampleMethod()</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">#endregion </font>ISample Members</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

==== Indentation deep ====

*All methods' indentation must not exceed a deep level of 3. Methods, whose indentation exceeds 3 in deep level, decrease readability, maintainability and also increase complexity.

''<u>Must not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">if </font>(HasAccess)</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">for </font>(<font color="#0000ff">int </font>i = 0; i &lt; COUNT; i++)</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">if </font><font color="#0000ff">(</font>list[i].IsTrue)</font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">switch </font> (resourceType)</font>
::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#ff0000">{</font> </font>
:::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#ff0000"><font face="Arial, sans-serif">=&gt; Code inside this block are too deep</font></font></font> 
::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#ff0000">}</font></font> 
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 
<div style="border: 1pt solid rgb(0, 0, 0); padding: 5px; background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial; color: rgb(0, 0, 255);">
'''Tips:''' <br> There are 2 methods for reducing the deep level of code block: 

*Reorganizing if statement

''<u>Original code:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">void </font>SampleMethod(<font color="#0000ff">bool </font>someCondition)</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">if </font>(someCondition)</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">for </font>(<font color="#0000ff">int </font>i = 0; i &lt; COUNT; i++)</font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

''<u>Changed code:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">void </font>SampleMethod(<font color="#0000ff">bool </font>someCondition)</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">if </font> (!someCondition) </font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">return </font>;</font> 
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">for </font>(<font color="#0000ff">int </font>i = 0; i &lt; COUNT; i++)</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

=&gt; The indentation's deep level has been decreased by 1. 

*Creating private method

''<u>Original code:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">void </font>SampleMethod(<font color="#0000ff">bool </font>someCondition)</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">if </font>(HasAccess)</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">for </font>(<font color="#0000ff">int </font>i = 0; i &lt; COUNT; i++)</font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">if </font>(list[i].IsTrue)</font>
::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
:::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">foreach </font>(<font color="#0000ff">int </font>value <font color="#0000ff">in </font> list[i].Values)</font>
:::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">if </font>(value &gt; 0)</font>
::::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
:::::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">for </font>(<font color="#0000ff">int </font>j = 0; j &lt; value; j++)</font>
:::::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::::::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">if </font>(anotherCondition)</font>
::::::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
::::::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
:::::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
::::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
:::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

''<u>Changed code:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">void </font>SampleMethod(<font color="#0000ff">bool </font>someCondition)</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">if </font>(HasAccess)</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">for </font>(<font color="#0000ff">int </font>i = 0; i &lt; COUNT; i++)</font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">if </font>(list[i].IsTrue)</font>
::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
:::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">ProcessValues(list[i].Values);</font> 
::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">void </font>ProcessValues(<font color="#2b91af">List</font>&lt;<font color="#0000ff">int</font>&gt; values)</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">foreach</font> (<font color="#0000ff">int </font>value <font color="#0000ff">in </font>values)</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">if </font>(value &gt; 0)</font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">for </font>(<font color="#0000ff">int </font>j = 0; j &lt; value; j++)</font>
::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
:::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">if </font>(anotherCondition)</font>
:::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
:::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
::::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

=&gt; The indentation's deep level is dreased more than 1 
</div> 
==== Attribute declaration ====

*For elements that have more than one Attribute declaration, then each <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">Attribute</font> must be put on one line.

''<u>Must not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">[<font color="#2b91af">Serializable</font>, <font color="#2b91af">STAThread</font>, <font color="#2b91af">Obsolete</font>(<font color="#a31515">"This class is obsolete. Use class Abc instead."</font>)]</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af">SampleClass</font></font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

''<u>Must:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">[<font color="#2b91af">Serializable</font>]</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">[<font color="#2b91af">STAThread</font>]</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">[<font color="#2b91af">Obsolete</font>(<font color="#a31515">"This class is obsolete. Use class Abc instead."</font>)]</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af">SampleClass</font></font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

== Coding guidelines ==

=== Basic language usage ===

==== Access modifier ====

*All access modifier must be explicitly given, except in interface's declaration where <font color="#0000ff"><font face="Courier New, monospace">public</font></font> is undertood by default.

''<u>Must not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">class </font><font color="#2b91af">SampleClass</font></font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">int </font>sampleInt;</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">void </font>SampleMethod()</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{</font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

==== Variables and Types ====

*If possible, initialize variables at declaration time.

''<u>Should:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">int </font>primaryId = 0;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#0000ff">string </font>sampleString = <font color="#0000ff">string</font>.Empty;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font><font color="#2b91af">List</font>&lt;<font color="#0000ff">int</font>&gt; sampleList = <font color="#0000ff">new</font> <font color="#2b91af">List</font>&lt;<font color="#0000ff">int</font>&gt;();</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

*Must use fully qualified name of types, declare the type by using statements. In case there are duplication in type's name, define aliases.

''<u>Must not:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#2b91af">ResourceCollectionPager</font> pager = CatGlobe.Framework.Services.<font color="#2b91af">SessionManager</font>.Current.DataModule.Get&lt;<font color="#2b91af">ResourceCollectionPager</font>&gt;(Request[<font color="#a31515">"sessionid"</font>]);</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

''<u>Must:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using</font> CatGlobe.Framework.Services;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#2b91af">ResourceCollectionPager</font> pager = <font color="#2b91af">SessionManager</font>.Current.DataModule.Get&lt;<font color="#2b91af">ResourceCollectionPager</font>&gt;(Request[<font color="#a31515">"sessionid"</font>]);</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 
<div style="border: 1pt solid rgb(0, 0, 0); padding: 5px; background: rgb(192, 192, 192) none repeat scroll 0% 0%; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial; color: rgb(0, 0, 255);">
'''Tips:''' <br> Always choose “using” over fully qualified name from Resolve menu of Visual Studio. [[Image:Coding Guidelines Common rules 1.0 html m6738e672.png|center|400px|Resolve menu of VS2008]] 
</div> 
''<u>Example of using alias:</u>'' <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>Threading = System.Threading;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>Timers = System.Timers;</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">using </font>Web = System.Web.UI;</font>

:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">namespace</font>CatGlobe.DataAccess</font>
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">public </font><font color="#0000ff">class </font><font color="#2b91af">SampleClass</font></font>
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">{ </font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font>Threading.<font color="#2b91af">Timer</font> _threadTimer1;</font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font>Timers.<font color="#2b91af">Timer</font> _threadTimer2;</font>
:::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"><font color="#0000ff">private </font>Web.<font color="#2b91af">Timer</font> _threadTimer3;</font> 
::<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font> 
:<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">}</font>

<font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font> 

==== Constants and Literals ====

*Never hardcoded strings that will be presented to end-users. Use <font face="Courier New, monospace" size="2" color="#33a3a3" style="font-size: 9pt;">Resoures</font> class instead.

''<u>Must not</u>'': 
<source lang="xml">
    <span>Username</span> 
</source>

''<u>Must</u>'': 
<source lang="xml">
    <span><%=Resources.Username %></span> 
</source>

*Try to use @ instead escape characters symbol

''<u>Should:</u>'' 
<source lang="csharp">
    string filename = @"D:\test\test.xml"; 
</source>

==== Direct cast vs. <font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">as</font> keyword ====

Following code block: 
<source lang="csharp">
    CustomClass a = src as CustomClass;
</source>

can be considered the same as the code block below: <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
<source lang="csharp">
    if (src is CustomClass)
        return (CustomClass)src; 
    else
        return null; 
</source>

Consequently, it is encouraged to use <font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">as</font> keyword over directcasting, because it is neat and safer.

=== Exceptions handling ===

*Catch least generic exception first

''<u>Must not:</u>'' 
<source lang="csharp">
    try 
    {
        using (FileStream fs = newFileStream(@"D:\test.xml")) { } 
    } 
    catch (Exception) { } 
    catch (IOException) 
    {
        =>Unreachable code 
    } 
</source>

*Do not use exception for controlling flows, instead try to validate input parameter. Most of the time exceptions can be prevented by proper input validation.

''<u>Should not</u>'': <font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;"></font>
<source lang="csharp">
    string input = "something"; 
    try 
    {
        DoWork(input); 
    } 
    catch (Exception e) 
    {
        DoAlternateWork(input); 
    } 
</source>

*All exception must be re-thrown, the outest layer (usually GUI win-form or web-form) must responsible for handling the exception properly.

''<u>Must not</u>'': 
<source lang="csharp">
    try 
    {
        DoWork(); 
    } 
    catch (Exception e) 
    {
        // do nothing 
    } 
</source>

*If not creating a wrapper exception, use “<font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">throw</font>” instead of “<font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">throw</font><font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">e</font>” to reserve the call-stack. “<font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">throw</font>” statement's stack trace points to the code place that actually causes the error, while “<font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">throw</font><font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">e</font>”'s stack trace points to the location of the “<font face="Courier New, monospace" size="2" color="#0000ff" style="font-size: 9pt;">throw</font><font face="Courier New, monospace" size="2" color="#000000" style="font-size: 9pt;">e</font>” statement only.

''<u>Must not</u>'': 
<source lang="csharp">
    catch (IOException ioe) 
    {
        Logger.LogError(ioe); 
        throw ioe; => Must be throw; 
    } 
</source>

''<u>Correct</u>'': 
<source lang="csharp">
    catch (IOException ioe) 
    {
        Logger.LogError(ioe); 
        throw new CustomeException("error", ioe); 
    } 
    catch (IOException ioe) 
    {
        Logger.LogError(ioe); 
        throw; 
    } 
</source>

== Document revisions ==

{|
|-
| '''Version No.''' 
| '''Date''' 
| '''Changed By''' 
| '''Description'''
|-
| 0.1 
| 10.07.2008 
| Nguyen Trung Chinh 
| Copy from http://blogs.msdn.com/brada/articles/361363.aspx
|-
| 0.1 
| 22.08.2008 
| Nguyen Trung Chinh 
| Refine from original document, add more applicable rules
|-
| 0.1 
| 25.08.2008 
| Nguyen Trung Chinh 
| Fix for 0.1 after reviews of Dennis and Thuan
|-
| 0.2 
| 08.10.2008 
| Nguyen Trung Chinh 
| Add section 3.5 and 4
|-
| 0.3 
| 13.10.2008 
| Nguyen Trung Chinh 
| Finish section 4
|-
| 1.0 
| 14.11.2008 
| Nguyen Trung Chinh 
| Finalize version 1.0
|}

[[Category:Technical guidelines]]