Comments in C#
Comments are the self-explanatory notes to
provide detailed information about our codes.
It’s always a good practice to include comments in our code so as to provide detailed information about what specific block or line of code can do. The comments benefit us or anyone else who examines the code at latter time.
We can include comments anywhere in the program without effecting our code and the comments do not affect the performance of an application because the comments won’t be compiled and executed by the compiler.
There are three types of comments available in C#, these are
- Single-line Comments
- Multi-line Comments
- XML Comments
Single Line Comments in C#
Single Line Comments are defined by using // (double forward slash).
The single line comment syntax in C# is defined below.
Single line comment starts with double forward slash
and any statement in right side of the characters.
using System;
namespace CsharpnaijaTutorial
{
class Program
{
static void Main(string[] args)
{
// Calling
Method to Show Greet Messaging
GreetMessage();
Console.WriteLine("Press Any Key to Exit..");
Console.ReadLine(); // This method to read the inputs from console
}
// This Method
will display the welcome message
public static void GreetMessage()
{
Console.WriteLine("You are Welcome to Csharpnaija Tutorial");
}
}
}
From the above code, we
will observe the single line comments in three places starting with // either at
the beginning of new line o as continuation of our line of code.
C# Multiline comments
Multiline Comments are used to comment multiple
lines of code, multiple line of comments are surrounded by slash and asterisk
like /*…*/.
The syntax of multiline comments in C# is
as shown below
using System;
namespace Tutlane
{
class Program
{
static void Main(string[] args)
{
/*
Define & assign a variable and
Send a variable to the method to
display
*/
string msg = "Welcome to Csharpnaija
Tutorial";
GreetMessage(msg);
Console.WriteLine("Press Enter Key to Exit..");
Console.ReadLine();
}
public static void GreetMessage(string message)
{
Console.WriteLine(message);
}
}
}
By observing the above
code, we defined a multiline comments to describe what the specific block or
line of code can do.
XML Comments in C#
XML Comments are the special type of comments
and these will be added above the definition of any user-defined type or
member.
XML Comments are defined by using /// (triple forward
slashes) and with XML formatted comment body as shown in the syntax below
Syntax of xml comments in C# programming
language.
///<summary>
/// This class does something.
///</summary>
public class SomeCsharpClass
{
//some codes
here
}
Sample Code of xml
Comments in C# is shown below
using System;
namespace CsharpnaijaTutorial
{
class Program
{
static void Main(string[] args)
{
string msg = "Welcome to Csharpnaija
Tutorial";
GreetMessage(msg);
Console.WriteLine("Press Enter Key to Exit..");
Console.ReadLine();
}
///<summary>
/// Method to Display Welcome Message
///</summary>
///<param
name="message"></param>
public static void GreetMessage(string message)
{
Console.WriteLine(message);
}
}
}
From the above code
sample, we can observe that, we defined an xml comments to describe what the
specific block or line of code can do.
Here the <summary> tag is used to add detailed information
about a type or member and <param> tag is used to describe the method
parameters.
Comments
Post a Comment