Comments in C/C++

A well-documented program is a good practice as a programmer. It makes a program more readable and error finding become easier. One important part of good documentation is Comments.

  • In computer programming, a comment is a programmer-readable explanation or annotation in the source code of a computer program
  • Comments are statements that are not executed by the compiler and interpreter.

In C/C++ there are two types of comments :

  1. Single line comment
  2. Multi-line comment

Single line Comment

Represented as // double forward slash

It is used to denote single line comment. It apply comment to a single line only. It is refereed as C++-style comments as it is originally part of C++ programming.
for example:



// single line comment

Example :

filter_none

edit
close

play_arrow

link
brightness_4
code

// C program to illustrate
// use of multi-line comment
#include <stdio.h>
int main(void)
{
  
    // Single line Welcome user comment
    printf("Welcome to GeeksforGeeks");
    return 0;
}

chevron_right






                        filter_none









Output:


Welcome to GeeksforGeeks





Multi-line comment


Represented as /* any_text */ start with  forward slash  and asterisk (/*) and end with asterisk and forward slash (*/).

It is used to denote multi-line comment. It can apply comment to more than a single line. It is referred as C-Style comment as it was introduced in C programming.


/*Comment starts
continues
continues
.
.
.
Comment ends*/



Example : 











                                    filter_none




                                    edit

                                    close




                                    play_arrow




                                    link

                                    brightness_4

                                    code
                                




















/* C program to illustrate  


use of  


multi-line comment */


#include <stdio.h> 


int main(void) 


{ 


  


    /* Multi-line Welcome user comment  


    written to demonstrate comments 


    in C/C++ */


    printf("Welcome to GeeksforGeeks"); 


    return 0; 


} 



















                        chevron_right







                        filter_none









Output:


Welcome to GeeksforGeeks





Comment at End of Code Line


You can also create a comment that displays at the end of a line of code. But generally its a better practice to put code before the line of code.

Example : 


 int age; // age of the person


When and Why to use Comments in programming?


    

  1. A person reading a large code will be bemused if comments are not provided about details of the program. 
    2. 

  2. Comments are a way to make a code more readable by providing more description.
    3. 

  3. Comments can include a description of an algorithm to make code understandable.
    4. 

  4. Comments can be helpful for one’s own self too if code is to be reused after a long gap.
    5. 




          
          
          
          

            

    

        My Personal Notes
        arrow_drop_up
    

    

        
        

            
            
        

    


Recommended Posts:
Himanshu_Singh_Bisht
Check out this Author's contributed articles.
If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.
Please Improve this article if you find anything incorrect by clicking on  the "Improve Article" button below.