This topic outlines some basic naming conventions used when writing in the C# language. Like all conventions, they are not enforced by the compiler, but will ensure readability between developers.
For comprehensive .NET framework design guidelines, see docs.microsoft.com/dotnet/standard/design-guidelines.
Choose easily readable identifier names
For example, a property named HorizontalAlignment is more readable in English than AlignmentHorizontal.
Favor readability over brevity
The property name
CanScrollHorizontally is better than
ScrollableX (an obscure reference to the X-axis).
Avoid using underscores, hyphens, or any other non-alphanumeric characters.
Do not use Hungarian notation
Hungarian notation is the practice of including a prefix in identifiers to encode some metadata about the parameter, such as the data type of the identifier, e.g.
Also, avoid using identifiers that conflict with keywords already used within C#.
Abbreviations and acronyms
In general, you should not use abbreviations or acronyms; these make your names less readable. Similarly, it is difficult to know when it is safe to assume that an acronym is widely recognized.
The following terms describe different ways to case identifiers.
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:
The first letter of an identifier is lowercase and the first letter of each subsequent concatenated word is capitalized. For example:
All letters in the identifier are capitalized. For example:
When an identifier consists of multiple words, do not use separators, such as underscores ("_") or hyphens ("-"), between words. Instead, use casing to indicate the beginning of each word.
The following table summarizes the capitalization rules for identifiers and provides examples for the different types of identifiers:
|Read-only static field||Pascal||RedValue|
More information can be found on MSDN.
Use a singular name for most Enums
Use a plural name for Enum types that are bit fields
Note: Always add the
FlagsAttribute to a bit field Enum type.
Do not add 'enum' as a suffix
Do not use the enum name in each entry
Add 'exception' as a suffix
Custom exception names should be suffixed with "-Exception".
Below are correctly named exceptions:
Interfaces should be named with nouns or noun phrases, or adjectives that describe behaviour. For example
IComponent uses a descriptive noun,
ICustomAttributeProvider uses a noun phrase and
IPersistable uses an adjective.
Interface names should be prefixed with the letter
I, to indicate that the type is an interface, and Pascal case should be used.
Below are correctly named interfaces:
The general format for namespaces is:
Prefixing namespace names with a company name prevents namespaces from different companies from having the same name.
There are two common conventions for private fields: