Comentários em código
Adicione anotações ao seu código fonte
Comentários são textos que podem ser inseridos no código fonte sem que sejam considerados pelo compilador. Os comentários são úteis para:
- Fazer anotações no código com o objetivo de esclarecer para que serve um trecho do programa.
- Indicar se o código precisa de revisão, se já foi feita alguma modificação ou se há alguma modificação para ser feita.
- Comentar linhas de código para que não sejam compiladas com o objetivo de encontrar erro no programa (debug).
É importante comentar bem seu código, seja para informar aos outros programadores o que o código faz ou mesmo para que você se lembre futuramente do que foi feito, caso necessite fazer correções ou modificações.
Há dois modos de comentar um código em c e c++. Para um comentário em várias linhas, coloque o texto entre /* e */. Comentário de uma única linha requer // no início da linha: Veja o exemplo abaixo:
/*
Programa com exemplo de comentários de
várias linhas e de uma linha somente.
*/ //Incluindo definições da biblioteca para escrita na tela
#include <stdio.h>// Esta é a função principal do programa
int main()
{
//Imprime Hello world! na tela
printf("Hello world!\n"); return 0;} //fim da função main
Suponhamos que o programa tenha um erro numa determinada linha. Você pode comentar a linha para verificar se o erro realmente ocorreu nesta. Existe uma forma melhor de depurar (consertar erros) por meio de programas especializados chamados debuggers.
Não é necessário comentar cada linha do seu código e deixá-lo sobrecarregado de comentários e difícil para ler. Faça anotações nos locais mais críticos, em que você acredita que a compreensão pode ser mais complexa.
