C++ - Comentários

Uma parte importante da programação e escrita de código é identificar e explicar o que escrevemos de modo a facilitar a leitura, seja para nós próprios ou para os outros que poderão lê-lo.

Isto faz-se partir de uma ferramenta chamada comentário.

Os comentários não são lidos pelo compiler, ou seja, são apenas úteis para o programador, seja para organizar ou para explicar o código. No fundo, é como se nem estivessem lá. Mas é preciso ter cuidado para não interferirem com o código, se estiverem mal posicionados.

Linha única (//)

Para adicionar um comentário de um linha no C++, é necessário colocar "//" antes das palavras do comentário.

Exemplo:

int num = 1;
//Olá! Isto é um comentário!
char h = 'H';

Como veem, o que está depois do "//" é um comentário.
Pode ser colocado em cima, em baixo, e há direita de código, mas nunca há esquerda (e obviamente também não no meio do código). Se à esquerda, todo o código que está à direita transforma-se num comentário.

À direita:

int num = 3; //Aqui, criamos uma variável de valor 3

À esquerda:

//Aqui, criamos uma variável de valor 3 int num = 3;

Múltiplas linhas (/* */)
Para adicionar um comentário de várias linhas, é necessário colocar "/*" no início, e "*/" no fim.
Exemplo:

/* Isto
   é
   um
   comentário */

O comentário engloba então essas 3 linhas mais um restinho da quarta.

Não necessariamente tem de ser de várias linhas. Pelo contrário, posso usar este tipo de comentário para criar um comentário ainda mais pequeno, com os limites definidos. Diferente do comentário de uma linha ("//") que começa num lugar e vai até o fim da linha.

Exemplo:

/* Comentário */ int num = 3;
int number = 5; /* Comentário 2 */

Vou também usar os comentários para explicar certas partes de códigos futuramente.
É sempre um bom hábito comentar os nossos códigos, nem que seja para ficar mais bonito. É muito importante no caso de nos esquecermos o que o código faz. Muitas vezes, vamos ter escrito tanto código que ficamos perdidos!

Referências

• GeeksforGeeks - Comments (Imagem)