Como comentar códigos em C++: // e /* */

Neste tutorial, vamos aprender uma prática de extrema importância no mundo da programação: como comentar códigos.

• Estudar pela apostila

Comentários: O que são? Para que servem? Por que usar?

Uma das partes mais importantes, de um código de programação, por incrível que pareça, é algo que ignorado pelo compilador: os comentários.

Usamos os comentários para uma comunicação humana, para que você programador diga algo para outro programador que vai ler seu código (pode até pra você mesmo, no futuro).

Eles são muito usados para descrever, em nossa linguagem humana, o que as linhas de códigos seguintes vão fazer, como funcionam, para que servem e dar o maior número detalhes possíveis.

Pode parecer bobagem no início, e de fato é, pois no começo nossos códigos são bem pequenos.
Mas a medida que vão ficar maiores e mais complexos, se torna uma tarefa árdua tentar entender o que um código faz apenas olhando, seria muito mais fácil se ele visse com explicações, e é aí que entram os comentários.

Imagine que você programou um game em C++, dezenas de milhares de linhas, lançou, ficou rico e tudo mais. Porém, 5 meses depois, descobriram um bug.

Amigo, pode ter certeza: ao rever o código, você vai ter extrema dificuldade de saber o que cada trecho faz e qual sua função, a gente esquece mesmo e dá um trabalho absurdo tentar entender um código só vendo aquela sopa de letrinhas.

Comente seus códigos, explique o que são, para que servem, o que determinada lógica ou algoritmo está fazendo e dê o máximo de informações possíveis. Isso é um excelente hábito de programação: comentar códigos.

Como comentar uma linha em C++: //

Para comentar uma linha (ou seja, fazer com que uma linha do código seja um comentário), basta iniciar ela com duas barras:

#include <iostream>
using namespace std;

int main()
{
    // Rush é a melhor banda do mundo
    cout << "Bem vindos ao curso C++ Progressivo";
    return 0;
}

Note que o texto "Rush é a melhor banda do mundo", não aparece na tela do usuário:

Vamos um exemplo realmente útil de código. O programa abaixo calcula a área de um círculo:

#include <iostream>
using namespace std;

int main()
{
    float raio, area;

    // Pedindo o raio
    cout << "Valor do raio: ";
    cin >> raio;

    // Calculando a área
    area = 3.14 * raio * raio;

    cout << "Area: " << area;
    return 0;
}

Lembre-se: pode parecer bobo agora, mas é porque são exemplos simples.
A medida que nossos algoritmos forem ficando maiores e mais complexos, você vai notar a importância de comentar seus códigos.

É uma característica clara e presente nos melhores programadores, e como você estudou pelo C++ Progressivo, certamente faz parte desse seleto grupo. Então, COMENTE SEUS CÓDIGOS.

Como comentar várias linhas: /* */

Muitas vezes, é interessantes fazermos uso de várias linhas para comentar corretamente um código.
Isso é bem comum no início dos arquivos, dando uma breve descrição do programa, suas funções, falando do autor etc.

Isso ficaria muito trabalhoso usando as barras // em toda linha.
Para comentar várias linhas de uma vez só, comece com: /*
Escreva o que quiser.
Termine com: */

Prontinho, tudo que estiver entre esses dois símbolos, é considerado um comentário.
Vamos fazer um programa em C++ que pede o raio, e mostra o valor do perímetro e da área de um círculo.

/*
    Programa: circulo.cpp
    Autor: C++ Progressivo
    Objetivo: esse programa recebe o valor do raio,
              do usuário, e retorna o valor do perímetro
              e da área do círculo
*/

#include <iostream>
using namespace std;

int main()
{
    float raio, area, perim;

    cout << "Raio: ";
    cin >> raio;

    area = 3.14 * raio * raio;
    perim = 2 * 3.14 * raio;

    cout << "Perímetro: " << perim << endl;
    cout << "Area: " << area;
    return 0;
}

Bem bonito e organizado, não?