C# Comments

Comments are used to explain the code and make it easier to read and understand. They also help programmers maintain and update the program in the future.

What are C# Comments?

C# comments are non-executable lines of text that are used to describe or explain the code. They help programmers document variables, methods, classes, and logic. Comments are ignored by the C# compiler; they do not affect the execution of the program.

C# supports two main types of comments: single-line comments (//) and multi-line comments (/* ... */).

C# Simple Comments Example

Let us take a simple example to illustrate the comments in C# programming.

Output:

Welcome to Tpoint tech

Explanation:

In this example, we represent the single-line and multi-line comments in C#. These lines cannot be compiled by the Compiler. After that, we use the Console.WriteLine() function to print the program.

Types of Comments

There are three types of comments in C#.

• Single-line Comments
• Multi-line Comments
• XML Comments

Here, we will discuss these comments one by one.

Single-line Comments

In C#, single-line comments are used to explain the short description of the line of code. It begins with two forward slashes (//). The compiler ignores any text between forward slash (//). These are commonly used during testing or debugging to highlight specific code segments, provide brief explanations, or temporarily disable particular lines of code.

Syntax

It has the following syntax:

Let us take an example to illustrate the single-line comments in C#.

Output:

Enter the first number: 15
Enter the second number: 20
The sum of 15 and 20 is 35

Explanation:

In this example, we demonstrate how to write the single-line comment in C#. It starts with two forward slashes (//). In this example, we take three integer inputs x, y, and sum. Finally, the output is displayed using the Console.WriteLine() function.

Multi-line Comments

In C#, multi-line comments are used to provide detailed descriptions of the line of code. It starts with /* and ends with */. The compiler ignores any text between /* and */. Any content written between these markers is completely disregarded by the compiler and has no behavior on how the program executes. Multi-line comments are helpful for adding documentation, explaining complex logic, or temporarily disabling several lines of code for debugging.

Syntax

It has the following syntax:

Let us take an example to illustrate the multi-line comments in C#.

Output:

Enter a number: 6
Factorial of 6 is 720

Explanation:

In this example, we demonstrate how to write the multi-line comment in C#. Here, the program prompts the user to enter the integer and calculates its factorial using a for loop. Multi-line comments are used to explain the logic and steps clearly within the code. After that, the Console.WriteLine() function is used to print the output.

XML Comments

In C#, XML comments are a special type of comment in C# that is used to create the code documentation by adding the xml elements. It provides the IntelliSense information and improves the code readability. It starts with the /// symbol. The compiler ignores any text following the /// symbol.

Syntax

It has the following syntax:

Let us take an example to illustrate the XML comments in C#.

Output:

The product of two numbers is 15

Explanation:

In this example, we demonstrate how to write the XML comments in C#. The compiler ignores any text that starts with /// symbol. First, we create a class named Number and a function named Multiply that takes two integer values, a and b, and returns their product. After that, we create the object of the class in the main function and print the output using the Console.WriteLIne() function.