C# Convensions Cheat‐Sheet - Gr8-Tools/game-developer-roadmap-doc GitHub Wiki

C# Coding Standards and Naming Conventions

Object Name	Notation	Length	Plural	Prefix	Suffix	Abbreviation	Char Mask	Underscores
Namespace name	PascalCase	128	Yes	Yes	No	No	[A-z][0-9]	No
Class name	PascalCase	128	No	No	Yes	No	[A-z][0-9]	No
Constructor name	PascalCase	128	No	No	Yes	No	[A-z][0-9]	No
Method name	PascalCase	128	Yes	No	No	No	[A-z][0-9]	No
Method arguments	camelCase	128	Yes	No	No	Yes	[A-z][0-9]	No
Local variables	camelCase	50	Yes	No	No	Yes	[A-z][0-9]	No
Constants name	PascalCase	50	No	No	No	No	[A-z][0-9]	No
Field name Public	PascalCase	50	Yes	No	No	Yes	[A-z][0-9]	No
Field name Private	_camelCase	50	Yes	No	No	Yes	_[A-z][0-9]	Yes
Properties name	PascalCase	50	Yes	No	No	Yes	[A-z][0-9]	No
Delegate name	PascalCase	128	No	No	Yes	Yes	[A-z]	No
Enum type name	PascalCase	128	Yes	No	No	No	[A-z]	No

1. Do use `PascalCasing` for class names and method names:

public class ClientActivity {
  public void ClearStatistics() {
    //...
  }
  public void CalculateStatistics() {
    //...
  }
}

Why: consistent with the Microsoft's .NET Framework and easy to read.

2. Do use `camelCasing` for method arguments and local variables:

public class UserLog {
  public void Add(LogEvent logEvent) {
    int itemCount = logEvent.Items.Count;
    // ...
  }
}

Why: consistent with the Microsoft's .NET Framework and easy to read.

3. Do not use Hungarian notation or any other type identification in identifiers

// Correct
int counter;
string name;    
// Avoid
int iCounter;
string strName;

Why: consistent with the Microsoft's .NET Framework and Visual Studio IDE makes determining types very easy (via tooltips). In general, you want to avoid type indicators in any identifier.

4. Use Screaming Caps for constants:

public const string SHIPPINGTYPE = "DropShip";

Acordinally to the Microsoft's .NET Framework Caps grab too much attention. But in my practice it's not so.

5. Use meaningful names for variables. The following example uses seattleCustomers for customers who are located in Seattle:

var seattleCustomers = from customer in customers
                       where customer.City == "Seattle" 
                       select customer.Name;

Why: consistent with the Microsoft's .NET Framework and easy to read.

6. Avoid using Abbreviations. Exceptions: abbreviations commonly used as names, such as Id, Xml, Ftp, Uri.

// Correct
UserGroup userGroup;
Assignment employeeAssignment;

// Avoid
UserGroup usrGrp;
Assignment empAssignment; 

// Exceptions
CustomerId customerId;
XmlDocument xmlDocument;
FtpHelper ftpHelper;
UriPart uriPart;

Why: consistent with the Microsoft's .NET Framework and prevents inconsistent abbreviations.

7. Do use PascalCasing or camelCasing (Depending on the identifier type) for abbreviations 3 characters or more (2 chars are both uppercase when PascalCasing is appropriate or inside the identifier).:

HtmlHelper htmlHelper;
FtpTransfer ftpTransfer, fastFtpTransfer;
UIControl uiControl, nextUIControl;

Why: consistent with the Microsoft's .NET Framework. Caps would grab visually too much attention.

8. Do not use Underscores in identifiers. Exception: you can prefix private fields with an underscore:

// Correct
public DateTime clientAppointment;
public TimeSpan timeLeft;    

// Avoid
public DateTime client_Appointment;
public TimeSpan time_Left; 

// Exception (Class field)
private DateTime _registrationDate;

Why: consistent with the Microsoft's .NET Framework and makes code more natural to read (without 'slur'). Also avoids underline stress (inability to see underline).

9. Do use predefined type names (C# aliases) like `int`, `float`, `string` for local, parameter and member declarations. Do use .NET Framework names like `Int32`, `Single`, `String` when accessing the type's static members like `Int32.TryParse` or `String.Join`.

// Correct
string firstName;
int lastIndex;
bool isSaved;
string commaSeparatedNames = String.Join(", ", names);
int index = Int32.Parse(input);

// Avoid
String firstName;
Int32 lastIndex;
Boolean isSaved;
string commaSeparatedNames = string.Join(", ", names);
int index = int.Parse(input);

Why: consistent with the Microsoft's .NET Framework and makes code more natural to read.

10. Do use implicit type var for local variable declarations. Exception: primitive types (int, string, double, etc) use predefined names.

var stream = File.Create(path);
var customers = new Dictionary();

// Exceptions
int index = 100;
string timeSheet;
bool isCompleted;

Why: removes clutter, particularly with complex generic types. Type is easily detected with Visual Studio tooltips.

11. Do use noun or noun phrases to name a class.

public class Employee { }

public class BusinessLocation { }

public class DocumentCollection { }

Why: consistent with the Microsoft's .NET Framework and easy to remember.

12. Do prefix interfaces with the letter I. Interface names are noun (phrases) or adjectives.

public interface IShape { }

public interface IShapeCollection { }
public interface IGroupable { }

Why: consistent with the Microsoft's .NET Framework.

13. Do name source files according to their main classes. Exception: file names with partial classes reflect their source or purpose, e.g. designer, generated, etc.

// Located in Task.cs
public partial class Task { }

// Located in Task.generated.cs
public partial class Task { }

Why: consistent with the Microsoft practices. Files are alphabetically sorted and partial classes remain adjacent.

14. Do organize namespaces with a clearly defined structure:

// Examples
namespace Company.Technology.Feature.Subnamespace { }

namespace Company.Product.Module.SubModule { }

namespace Product.Module.Component { }

namespace Product.Layer.Module.Group { }

Why: consistent with the Microsoft's .NET Framework. Maintains good organization of your code base.

15. Do vertically align curly brackets:

// Correct
class Program {
  static void Main(string[] args) {
    //...
  }
}

Why: Microsoft has a different standard, but developers have overwhelmingly preferred vertically aligned brackets.

16. Use open braces on the same line and the close - on the new one.


public class Example {
  public void Foo(int a) {
    if (a < 0) {
      // do smth
    } else {
      // do anything else
    }
  }  
}

17. Do use singular names for enums. Exception: bit field enums.

// Correct
public enum Color {
  Red,
  Green,
  Blue,
  Yellow,
  Magenta,
  Cyan
} 

// Exception
[Flags]
public enum Dockings
{
  None = 0,
  Top = 1,
  Right = 2, 
  Bottom = 4,
  Left = 8
}

Why: consistent with the Microsoft's .NET Framework and makes the code more natural to read. Plural flags because enum can hold multiple values (using bitwise 'OR').

18. Do not explicitly specify a type of an enum or values of enums (except bit fields):

// Don't
public enum Direction : long {
  North = 1,
  East = 2,
  South = 3,
  West = 4
} 

// Correct
public enum Direction {
  North,
  East,
  South,
  West
}

Why: can create confusion when relying on actual types and values.

19. Do not use an "Enum" suffix in enum type names:

// Don't
public enum CoinEnum {
  Penny,
  Nickel,
  Dime,
  Quarter,
  Dollar
} 

// Correct
public enum Coin {
  Penny,
  Nickel,
  Dime,
  Quarter,
  Dollar
}

Why: consistent with the Microsoft's .NET Framework and consistent with prior rule of no type indicators in identifiers.

20. Do not use "Flag" or "Flags" suffixes in enum type names:

// Don't
[Flags]
public enum DockingsFlags {
  None = 0,
  Top = 1,
  Right = 2, 
  Bottom = 4,
  Left = 8
}
// Correct
[Flags]
public enum Dockings {
  None = 0,
  Top = 1,
  Right = 2, 
  Bottom = 4,
  Left = 8
}

Why: consistent with the Microsoft's .NET Framework and consistent with prior rule of no type indicators in identifiers.

21. Do use suffix EventArgs at creation of the new classes comprising the information on event:

// Correct
public class BarcodeReadEventArgs : System.EventArgs { }

Why: consistent with the Microsoft's .NET Framework and easy to read.

22. Do name event handlers (delegates used as types of events) with the "EventHandler" suffix, as shown in the following example:

public delegate void ReadBarcodeEventHandler(object sender, ReadBarcodeEventArgs e);

Why: consistent with the Microsoft's .NET Framework and easy to read.

23. Do not create names of parameters in methods (or constructors) which differ only by the register:

// Avoid
private void MyFunction(string name, string Name) {
  //...
}

Why: consistent with the Microsoft's .NET Framework and easy to read, and also excludes possibility of occurrence of conflict situations.

24. DO use two parameters named sender and e in event handlers. The sender parameter represents the object that raised the event. The sender parameter is typically of type object, even if it is possible to employ a more specific type.

public void ReadBarcodeEventHandler(object sender, ReadBarcodeEventArgs e) {
  //...
}

Why: consistent with the Microsoft's .NET Framework and consistent with prior rule of no type indicators in identifiers.

25. Do use suffix Exception at creation of the new classes comprising the information on exception:

// Correct
public class BarcodeReadException : System.Exception {
}

Why: consistent with the Microsoft's .NET Framework and easy to read.

26. Do use prefix Any, Is, Have or similar keywords for boolean identifier:

// Correct
public static bool IsNullOrEmpty(string value) {
    return (value == null || value.Length == 0);
}

Why: consistent with the Microsoft's .NET Framework and easy to read.

27. Use Named Arguments in method calls:

When calling a method, arguments are passed with the parameter name followed by a colon and a value.

// Method
public void DoSomething(string foo, int bar) {
...
}

// Avoid
DoSomething("someString", 1);
// Correct
DoSomething(foo: "someString", bar: 1);

Why: consistent with the Microsoft's .NET Framework and easy to read. In Named Arguments, we do not need to pass the parameters in order as defined on method definition, so we can pass the arguments in any order on method calling.

Declaration order

Access-modificator order

Public
Internal
Protected
Private Protected
Private

Member-type order

const
static events
static Properties
static Fields/_fields
static ctor's
events
Properties
Fields/fields
ctor's
Methods
static Methods

Try escape use regions to split code. Mostly, if you use regions to clearify your code, it can be splitted to different classes accordingly to Single Resposibility Principle (SRP of SOLID). But if it does not seem reasonable try use regions splitting on repsonsibilities factor. The same rules are applied within each region.

Why: generally accepted practice that prevents the need to hunt for variable declarations.

C# Convensions Cheat‐Sheet - Gr8-Tools/game-developer-roadmap-doc GitHub Wiki

C# Coding Standards and Naming Conventions

1. Do use PascalCasing for class names and method names:

2. Do use camelCasing for method arguments and local variables:

3. Do not use Hungarian notation or any other type identification in identifiers

4. Use Screaming Caps for constants:

5. Use meaningful names for variables. The following example uses seattleCustomers for customers who are located in Seattle:

6. Avoid using Abbreviations. Exceptions: abbreviations commonly used as names, such as Id, Xml, Ftp, Uri.

7. Do use PascalCasing or camelCasing (Depending on the identifier type) for abbreviations 3 characters or more (2 chars are both uppercase when PascalCasing is appropriate or inside the identifier).:

8. Do not use Underscores in identifiers. Exception: you can prefix private fields with an underscore:

9. Do use predefined type names (C# aliases) like int, float, string for local, parameter and member declarations. Do use .NET Framework names like Int32, Single, String when accessing the type's static members like Int32.TryParse or String.Join.

10. Do use implicit type var for local variable declarations. Exception: primitive types (int, string, double, etc) use predefined names.

11. Do use noun or noun phrases to name a class.

12. Do prefix interfaces with the letter I. Interface names are noun (phrases) or adjectives.

13. Do name source files according to their main classes. Exception: file names with partial classes reflect their source or purpose, e.g. designer, generated, etc.

14. Do organize namespaces with a clearly defined structure:

15. Do vertically align curly brackets:

16. Use open braces on the same line and the close - on the new one.

17. Do use singular names for enums. Exception: bit field enums.

18. Do not explicitly specify a type of an enum or values of enums (except bit fields):

19. Do not use an "Enum" suffix in enum type names:

20. Do not use "Flag" or "Flags" suffixes in enum type names:

21. Do use suffix EventArgs at creation of the new classes comprising the information on event:

22. Do name event handlers (delegates used as types of events) with the "EventHandler" suffix, as shown in the following example:

23. Do not create names of parameters in methods (or constructors) which differ only by the register:

24. DO use two parameters named sender and e in event handlers. The sender parameter represents the object that raised the event. The sender parameter is typically of type object, even if it is possible to employ a more specific type.

25. Do use suffix Exception at creation of the new classes comprising the information on exception:

26. Do use prefix Any, Is, Have or similar keywords for boolean identifier:

27. Use Named Arguments in method calls:

Declaration order

Access-modificator order

Member-type order

Official Reference

1. Do use `PascalCasing` for class names and method names:

2. Do use `camelCasing` for method arguments and local variables:

9. Do use predefined type names (C# aliases) like `int`, `float`, `string` for local, parameter and member declarations. Do use .NET Framework names like `Int32`, `Single`, `String` when accessing the type's static members like `Int32.TryParse` or `String.Join`.