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 :
- Single line comment
- 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.
// single line comment
Welcome to GeeksforGeeks
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*/
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.
int age; // age of the person
When and Why to use Comments in programming?
- A person reading a large code will be bemused if comments are not provided about details of the program.
- Comments are a way to make a code more readable by providing more description.
- Comments can include a description of an algorithm to make code understandable.
- Comments can be helpful for one’s own self too if code is to be reused after a long gap.
- Comments in Java
- Concept of Comments in Computer Programming
- How to create Radial Menu in CSS ?
- How to manage CSS Explosion?
- How to recursively delete a directory and its entire contents (files + sub dirs) in PHP?
- Find the number of ways to divide number into four parts such that a = c and b = d
- rsync command in Linux with Examples
- chrt command in Linux with examples
- Why to use fgets() over scanf() in C?
- session_unset() vs session_destroy() in PHP
If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to email@example.com. 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.