Skip to content

Latest commit

 

History

History
99 lines (71 loc) · 3.03 KB

Layout.Guidelines.md

File metadata and controls

99 lines (71 loc) · 3.03 KB

Layout Guidelines

Use a common layout

  • Keep the length of each line under 130 characters.
  • Use an indentation of 4 whitespaces, and don't use tabs
  • Keep one whitespace between keywords like if and the expression, but don't add whitespaces after ( and before ) such as:
if (condition == null)
  • Add a whitespace around operators, like +, -, ==, etc.
  • Always succeed the keywords if, else, do, while, for and foreach, with opening and closing parentheses, even though the language does not require it.
  • Always put opening and closing parentheses on a new line.
  • Indent object Initialisers and initialise each property on a new line, so use a format like this:
var dto = new ConsumerDto()
          {
              Id = 123,
              Name = "Microsoft",
              PartnerShip = PartnerShip.Gold,
          }
  • Don't indent lambda statements and use a format like this:
methodThatTakesAnAction.Do(x =>
{
  // do something like this 
}
  • Put the entire LINQ statement on one line, or start each keyword at the same indentation, like this:
var query = from product in products where product.Price > 10 select product;

or

var query =
    from product in products
    where product.Price > 10
    select product;
  • Start the LINQ statement with all the from expressions and don't interweave them with where restrictions.
  • Add braces around every comparison condition, but don't add braces around a singular condition. For example
if (!String.IsNullOrEmpty(str) && (str != "new"))
  • Add an empty line between multi-line statements, between members, after the closing parentheses, between unrelated code blocks, around the #region keyword, and between the using statements of different companies.

Order and group namespaces according the company 

// Microsoft namespaces are first
using System;
using System.Collections;
using System.XML;
 
// Then any other namespaces in alphabetic order
using AvivaSolutions.Business;
using AvivaSolutions.Standard;

using Telerik.WebControls;
using Telerik.Ajax;

Place members in a well-defined order

Maintaining a common order allows other team members to find their way in your code more easily. In general, a source file should be readable from top to bottom, as if you are reading a book. This prevents readers from having to browse up and down through the code file.

  1. Private fields and constants (in a region)
  2. Public constants
  3. Public read-only static fields
  4. Factory Methods
  5. Constructors and the Finalizer
  6. Events
  7. Public Properties
  8. Other methods and private properties in calling order

Be reluctant with #regions

Regions can be helpful, but can also hide the main purpose of a class. Therefore, use #regions only for:

  • Private fields and constants (preferably in a Private Definitions region).
  • Nested classes
  • Interface implementations (only if the interface is not the main purpose of that class)