osmano807

Bem, aproveitando que meu tempo livre aumentou, continuando o curso. Comentários variam muito de uma linguagem para outra, mas comentários em C++ se parecem muito com os de PHP, Java, C# pelo que pude ver.

Comentários
Um comentário é uma linha (ou várias) que é inserido no código do programa, descrevendo o que ele faz.
Em C++, // é o "símbolo" que define o início de um comentário de uma linha, que informa ao compilador desconsiderar tudo que vier após, até o final da linha.

Código PHP:

std::cout << "Olá" << std::endl; // Tudo a partir daqui é ignorado. 


Tipicamente, o comentário de uma linha é usado para fazer um breve comentário do que se passa nas linhas ao redor.

Código PHP:

cout << "Hello world!" << endl; // cout e endl estão na Lib iostream
cout  << "Que bom te ver!"  << endl; // esses comentários dificultam muito a leitura do código, não?
cout  << "Yeah!" <<  endl; // especialmente em linhas de diferentes tamanhos... 


Como podem ver, um comentário pode se tornar inútil se atrapalha a leitura. Se a linha for muito grande (e mesmo não sendo), é melhor botar o comentário em uma linha a parte:

Código PHP:

// cout e endl estão na Lib iostream
cout  << "Hello world!" << endl; 

// isto é muito mais fácil de ler
cout  << "Que bom te ver!"  << endl; 

// não acha?
cout  << "Yeah!" <<  endl; 


/* e */ são os caracteres que demarcam o comentário multi-linha, também conhecido como C-style (C só tem esse comentário, embora os compiladores aceitem // também...)
Tudo entre /* e */ é ignorado.

Código PHP:

/* Este é um comentário multi-linha.
Esta linha irá ser ignorada.
Esta também */ 


Comentários multi-linha não podem ser aninhados:

Código PHP:

/* Este é um comentário /* multi-linha */ isto não está no comentário */
//                                      ^ comentário termina aqui 


Regra: NUNCA aninhe comentários.

Seja inteligente, comente coisas que irão facilitar a vida futura, por exemplo:

Código PHP:

// Calculando o preço total
custo = itens / 2 * preco; 


Tá... porque dividimos por 2? Estou vendo que é para calcular o preço total, mas porque dividir por 2?

Código PHP:

// Calculando o preço total
// Como os itens são enviados em pares, dividimos por 2
custo = itens / 2 * preco; 


Melhor agora não?

Comentários são bons, mas quando usados corretamente. Não comente coisas óbvias, mas não deixe de comentar o útil.
Mas preste atenção: não é só porque você, programador do projeto, acha aquela parte do código auto-explicativa que outro irá achar. Ou você pensa: "Isto é óbvio, nunca vou esquecer disto". Adivinha? Você esquece.
Sempre comente seu código, uma hora você precisará desses comentários.