Skip to main content

Comments in C# Explained

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.

 // here is a single line comment in C# language.

Single line comment starts with double forward slash and any statement in right side of the characters.

 Below is a working example code for single line comment

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

 /* Multi Line Comment syntax */

 Example of multiline comment in C# in 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.

 Thank you

  References

Tutlane

Csharpcorner

w3schools

 

 

 


Labels:
Location: Abuja, Nigeria

Comments

Post a Comment

Popular posts from this blog

Collections in C#

Collections in C# In our previous article , we have learned about how we can use arrays in C#. Arrays in programming are used to group a set of related objects. So one could create an array or a set of Integers, which could be accessed via one variable name. What is Collections in C#? Collections are similar to Arrays, it provides a more flexible way of working with a group of objects. In arrays, you would have noticed that you need to define the number of elements in an array beforehand. This had to be done when the array was declared. But in a collection, you don't need to define the size of the collection beforehand. You can add elements or even remove elements from the collection at any point of time. This article will focus on how we can work with the different collections available in C#. There are three distinct collection types in C#: standard generic concurrent The standard collections are found under the System.Collections. They do not store elemen...
Post a Comment
Read more

The String.Join Method in C# Explained

The String.Join Method in C#   The string.Join concatenates the elements of a specified array or the members of a collection, using the specified separator between each element or member. Overloads of string.Join Method Description Join(Char, Object[]) Concatenates the string representations of an array of objects, using the specified separator between each member. Join(Char, String[]) Concatenates an array of strings, using the specified separator between each member. Join(String, IEnumerable<String>) Concatenates the members of a constructed IEnumerable<T> collection of type String, using the specified separator between each member. Join(String, Object[]) Concatenates the elements of an object array, using the specified separator between each element. Join(String, String[]) Concatenates all the elements of a string array, usi...
Post a Comment
Read more

System.IO Namesapce in C#

  System.IO Namesapce in C# A  file  is a collection of data stored in a disk with a specific name and a directory path. When a file is opened for reading or writing, it becomes a  stream . The stream is basically the sequence of bytes passing through the communication path. There are two main streams: the  input stream  and the  output stream . The  input stream  is used for reading data from file (read operation) and the  output stream  is used for writing into the file (write operation). From the above definition of file, the C# provides a namespace that enable us to manipulate file in C# called System.IO.   System.IO  is a  namespace  and it contains a standard IO (input/output) types such as classes , structures , enumerations , and  delegates  to perform a read/write operations on different sources like file, memory, network, etc.   System.IO Classes The table below shows differen...
Post a Comment
Read more