Comments in C++

The 'what' of the code should be commented when the code is difficult to understand or non-obvious.

A comment is a text ignored by the compiler and is added to explain the code and why a particular approach is taken.

Comments are added to explain what the code is doing, the reason why a particular approach is chosen, and to make notes for developers reading the code in the future.

There are two types of comments in C++: single line comments and multi-line comments.

Single line comments are added using two backslashes (//).

In Windows, use Ctrl + backslash; in Mac, use Command + backslash.

Single line comments can be used to comment out a single line of code for testing new versions of that line of code.

Multi-line comments begin with /* and end with */.

In Windows, use Ctrl + Shift + backslash; in Mac, use Command + Shift + backslash.

Unnecessary comments should be avoided, especially for obvious code, because they do not add significant value and may clutter the code.

It is considered a best practice to explain the 'why' of a code instead of the 'what', especially if the code is obvious.

The 'what' of the code should be commented when the code is difficult to understand or non-obvious.

A comment is a text ignored by the compiler and is added to explain the code and why a particular approach is taken.