Comentários C++

Comentários C++

Neste tutorial, aprenderemos sobre comentários em C++, por que os usamos e como usá-los com a ajuda de exemplos.

Comentários C++ são dicas que um programador pode adicionar para tornar seu código mais fácil de ler e entender. Eles são completamente ignorados pelos compiladores C++.

Há duas maneiras de adicionar comentários ao código:

// - Comentários de linha única

/* */ -Comentários de várias linhas

---

Comentários de linha única

Em C++, qualquer linha que comece com // é um comentário. Por exemplo,

// declaring a variable
int a;

// initializing the variable 'a' with the value 2
a = 2;

Aqui, usamos dois comentários de linha única:

• // declaring a variable
• // initializing the variable 'a' with the value 2

Também podemos usar um comentário de linha única como este:

int a;    // declaring a variable

---

Comentários de várias linhas

Em C++, qualquer linha entre /* e */ também é um comentário. Por exemplo,

/* declaring a variable
to store salary to employees
*/
int salary = 2000;

Essa sintaxe pode ser usada para escrever comentários de linha única e de várias linhas.

---

Usando comentários para depuração

Os comentários também podem ser usados ​​para desabilitar o código para evitar que ele seja executado. Por exemplo,

#include <iostream>
using namespace std;
int main() {
   cout << "some code";
   cout << ''error code;
   cout << "some other code";

   return 0;
}

Se obtivermos um erro durante a execução do programa, em vez de remover o código propenso a erros, podemos usar comentários para desativá-lo de ser executado; esta pode ser uma ferramenta de depuração valiosa.

#include <iostream>
using namespace std;
int main() {
   cout << "some code";
   // cout << ''error code;
   cout << "some other code";

   return 0;
}

Dica profissional: Lembre-se do atalho para usar comentários; pode ser realmente útil. Para a maioria dos editores de código, é Ctrl + / para Windows e Cmd + / para Mac.

---

Por que usar Comentários?

Se escrevermos comentários em nosso código, será mais fácil para nós entendermos o código no futuro. Além disso, será mais fácil para seus colegas desenvolvedores entenderem o código.

Observação: Os comentários não devem substituir uma maneira de explicar o código mal escrito em inglês. Devemos sempre escrever um código bem estruturado e autoexplicativo. E, em seguida, use comentários.

Como regra geral, use comentários para explicar Por que você fez algo em vez de Como você fez alguma coisa, e você é bom.