Tutorialspoint.dev

Comments in C#

Comments are used for explaining the code and are used in a similar manner as in Java, C or C++. Compilers ignore the comment entries and do not execute them. Generally, programming languages contain two types of comments but in C#, there are 3 Types of comments :

  1. Single Line Comments : It is used to comment a single line. These comment can be written in a seperate line or along with the codes in the same line. But for better understanding always use the comment in a seperate line.
    Syntax :

    // Single Line Comments
  2. Multiline Comments : It is used to comment more than one line. Generally this is used to comment out an entire block of code statements.
    Syntax :

    /* Multiline
    Comment */
    

    Example :

    // C# program to demonstrate the single 
    // line and multiline comments
    using System;
      
    namespace HelloGeeksApp {
          
    class HelloGeeks { 
      
        // Single Line Comment -- Function to print Message
        public static void Message(string message)
        {
            Console.WriteLine(message);
        }
          
        // Main function
        static void Main(string[] args)
        {
              
            /* Multiline Comment --
               Define a variable of
               string type and assign
               value to it*/
            string msg = "GeeksforGeeks";
              
            // Calling function
            Message(msg);
        }
    }
    }

    Output:



    GeeksforGeeks
    
  3. XML Documentation Comments : It is a special type of comment in C# and used to create the documentation of C# code by adding XML elements in the source code. XML elements are added in XML Documentation Comments of C#. For more details refer to XML Documentation Comments in C#
    Syntax :

    /// <summary>
    /// This class does something of program Summary.
    /// </summary>
    

    Example :

    // C# program to demonstrate XML
    // Documentation Comments 
    using System;
      
    namespace HelloGeeksApp {
           
    class HelloGeeks { 
       
        /// <summary>
        /// Method to Display Geeksforgeeks Message
        /// </summary>
        /// <param name="Geeksforgeeks"></param>
        public static void Message(string message)
        {
            Console.WriteLine(message);
        }
           
        // Main function
        static void Main(string[] args)
        {
               
            /* Define a variable of
               string type and assign
               value to it*/
            string msg = "GeeksforGeeks";
               
            // Calling function
            Message(msg);
        }
    }
    }

    Output:

    GeeksforGeeks
    

Note : The <summary> tag provides the information about the defined a type or member and <param> tag is method parameters.

Related Articles:



This article is attributed to GeeksforGeeks.org

leave a comment

code

0 Comments

load comments

Subscribe to Our Newsletter