Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
197 lines (106 sloc) 12.3 KB
title ms.custom ms.date helpviewer_keywords ms.assetid
C# Coding Conventions - C# Programming Guide
seodec18
07/20/2015
coding conventions, C#
Visual C#, coding conventions
C# language, coding conventions
f4f60de9-d49b-4fb6-bab1-20e19ea24710

C# Coding Conventions (C# Programming Guide)

Coding conventions serve the following purposes:

  • They create a consistent look to the code, so that readers can focus on content, not layout.

  • They enable readers to understand the code more quickly by making assumptions based on previous experience.

  • They facilitate copying, changing, and maintaining the code.

  • They demonstrate C# best practices.

The guidelines in this topic are used by Microsoft to develop samples and documentation.

Naming Conventions

  • In short examples that do not include using directives, use namespace qualifications. If you know that a namespace is imported by default in a project, you do not have to fully qualify the names from that namespace. Qualified names can be broken after a dot (.) if they are too long for a single line, as shown in the following example.

    [!code-csharpcsProgGuideCodingConventions#1]

  • You do not have to change the names of objects that were created by using the Visual Studio designer tools to make them fit other guidelines.

Layout Conventions

Good layout uses formatting to emphasize the structure of your code and to make the code easier to read. Microsoft examples and samples conform to the following conventions:

  • Use the default Code Editor settings (smart indenting, four-character indents, tabs saved as spaces). For more information, see Options, Text Editor, C#, Formatting.

  • Write only one statement per line.

  • Write only one declaration per line.

  • If continuation lines are not indented automatically, indent them one tab stop (four spaces).

  • Add at least one blank line between method definitions and property definitions.

  • Use parentheses to make clauses in an expression apparent, as shown in the following code.

    [!code-csharpcsProgGuideCodingConventions#2]

Commenting Conventions

  • Place the comment on a separate line, not at the end of a line of code.

  • Begin comment text with an uppercase letter.

  • End comment text with a period.

  • Insert one space between the comment delimiter (//) and the comment text, as shown in the following example.

    [!code-csharpcsProgGuideCodingConventions#3]

  • Do not create formatted blocks of asterisks around comments.

Language Guidelines

The following sections describe practices that the C# team follows to prepare code examples and samples.

String Data Type

Implicitly Typed Local Variables

Unsigned Data Type

  • In general, use int rather than unsigned types. The use of int is common throughout C#, and it is easier to interact with other libraries when you use int.

Arrays

Delegates

try-catch and using Statements in Exception Handling

&& and || Operators

  • To avoid exceptions and increase performance by skipping unnecessary comparisons, use && instead of & and || instead of | when you perform comparisons, as shown in the following example.

    [!code-csharpcsProgGuideCodingConventions#18]

New Operator

Event Handling

Static Members

  • Call static members by using the class name: ClassName.StaticMember. This practice makes code more readable by making static access clear. Do not qualify a static member defined in a base class with the name of a derived class. While that code compiles, the code readability is misleading, and the code may break in the future if you add a static member with the same name to the derived class.

LINQ Queries

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

    [!code-csharpcsProgGuideCodingConventions#25]

  • Use aliases to make sure that property names of anonymous types are correctly capitalized, using Pascal casing.

    [!code-csharpcsProgGuideCodingConventions#26]

  • Rename properties when the property names in the result would be ambiguous. For example, if your query returns a customer name and a distributor ID, instead of leaving them as Name and ID in the result, rename them to clarify that Name is the name of a customer, and ID is the ID of a distributor.

    [!code-csharpcsProgGuideCodingConventions#27]

  • Use implicit typing in the declaration of query variables and range variables.

    [!code-csharpcsProgGuideCodingConventions#25]

  • Align query clauses under the from clause, as shown in the previous examples.

  • Use where clauses before other query clauses to ensure that later query clauses operate on the reduced, filtered set of data.

    [!code-csharpcsProgGuideCodingConventions#29]

  • Use multiple from clauses instead of a join clause to access inner collections. For example, a collection of Student objects might each contain a collection of test scores. When the following query is executed, it returns each score that is over 90, along with the last name of the student who received the score.

    [!code-csharpcsProgGuideCodingConventions#30]

Security

Follow the guidelines in Secure Coding Guidelines.

See also

You can’t perform that action at this time.