C# Code Layout And Formatting With Specific Formatting Rules

C# Code layout and Formatting

When writing programming code in C#, code layout and formatting are essential components. They entail inserting characters that the compiler normally ignores, like as spaces, tabs, and new lines, but which give the code a logical structure and make it much simpler to read and comprehend. The major objectives of appropriate formatting are to improve readability and make code maintenance easier in the future.

General Principles of Code Formatting

Logical Structure Representation: The logical structure of your software should be reflected in its formatting. The goal of all formatting guidelines is to make code easier to understand by clearly displaying this structure.

Consistency: It is crucial that you choose and follow a particular formatting style for the duration of your project. A lack of convention can be more harmful than inconsistent formatting.

Self-Documenting Code: Writing code that is naturally clear and understandable produces the best documentation, even though comments are useful for elaborating on concepts. Because the structure and name of self-documenting code make its purpose clear, it frequently requires less explicit comments.

Specific Formatting Rules and Guidelines

Several important guidelines determine an efficient code layout based on Microsoft’s C# coding conventions:

Indentation:

Any code that logically belongs inside another should be indented to the right by one tab, such as methods inside classes or statements inside methods.
For every nesting level, nested sections of code are further indented.
Long conditions that span several lines in a loop or conditional statement should be moved over to a new line and indented by two tabs.

Brace Placement ({}):

Always place the starting curly bracket on its own line, right below the construct it defines, such as a method or class.
Along with its matching opening bracket, the closing curly bracket should be vertically aligned on its own line.
Curly brackets () should always enclose the body of loops and conditional statements, even if they only include one statement. This is a highly recommended practice. This eliminates uncertainty and any mistakes that may result from deceptive indentation.

Whitespace and Parentheses:

A space should be used between the starting parenthesis () and a keyword (for, while, if, or switch).
On the other hand, the initial parentheses () and the method name shouldn’t be separated by whitespace.
A space should come after each comma in the argument list in both method declarations and calls, but not before.

Empty Lines:

Similar to text paragraphs, empty lines are used to logically divide discrete, unrelated elements of a program.
Individual methods, various logical groups of member variables, or discrete blocks of related statements are usually separated using them. They should not be used carelessly since this can make them harder to read.

Line Length and Alignment:

Splitting a line of code into two or more lines is recommended if it gets too long. After that, a single tab should be used to indent subsequent lines.
Aligning comparable statements according to the length of the longest one is generally avoided because it can make code maintenance more difficult.

Class Content Ordering:

It is advised that members be listed in the following sequence within a class definition: class name, constants (arranged by access modifier: public, protected, and private), fields, properties, and methods.
It is preferable to arrange methods according to their functionality rather than just their scope or level of access.

Tools for Automated Formatting

Strong automated assistance for code formatting is provided by contemporary Integrated Development Environments (IDEs), such as Visual Studio. Generally, developers can use basic keyboard shortcuts like [Ctrl+K, Ctrl+F] to reformat a specified portion of code or an entire document. This mechanism aids in ensuring that formatting is uniform across the codebase, following either custom setups or predetermined standards.

Additionally, the Visual Studio Code Editor makes text easier to read by:

Code Colorization: Various elements, including as strings, comments, identifiers, and keywords, are shown in different colours.

Bold Colorization: Quotation marks, case/break statements, curly braces, and preprocessor directives (#if/#endif) are examples of matched pairs that are briefly shown in bold to emphasise their association.

Regions: To make big files more organised and navigable, programmers can define collapsable sections of code using the #region and #endregion directives.

Code Examples

Basic Code Layout Example:

Unformatted original code that is hard to read:

class HelloCSharp{static void Main(){System.Console.WriteLine("Hello C#!");}}

Code that is formatted (more readable and intelligible):

using System;
class HelloCSharp
{
    static void Main()
    {
        System.Console.WriteLine("Hello C#!");
    }
}

Output

Hello C#!

Syntax of Indentation and Brace Placement for a Class with Multiple Methods:

public class IndentationExample
{
    public static void FirstMethod()
    {
        // … Code for FirstMethod …
    } // One blank line follows

    public static void SecondMethod()
    {
        // … Code for SecondMethod …
    }
}

This illustrates how an if statement without curly braces leads to confusion since it only takes into account the statement that comes right after it as its body, regardless of visual indentation.

You can also read Namespaces In C# Purpose, Declaring And Advantages

Page Content

Tutorials

C# Code Layout And Formatting With Specific Formatting Rules