Como escrever comentários em programação C

O que é comentário na linguagem C?

A comentar é uma explicação ou descrição do código-fonte do programa. Ajuda o desenvolvedor a explicar a lógica do código e melhora a legibilidade do programa. Em tempo de execução, um comentário é ignorado pelo compilador.

Existem dois tipos de comentários em C:

1) Um comentário que começa com uma barra asterisco /* e termina com um asterisco barra */ e você pode colocá-lo em qualquer lugar do seu código, na mesma linha ou em várias linhas.

2) Comentários de linha única que usam uma barra dupla // dedicado a comentar linhas únicas

Exemplo de comentário de linha única

// single line comment example

Aqui está um exemplo de tipo de comentários

// C program to demo 
// Single Line comment 
#include <stdio.h> 
int main(void) 
{ 
  
	// This is a single line comment 
	printf("Guru99"); 
	return 0;  // return zero
}

Exemplo de comentário multilinha

/* Sample Multiline Comment
Line 1
Line 2
….
…
*/

Exemplo de comentário multilinha

#include <stdio.h>
int main() {
/* in main function
I can write my principal code
And this in several comments line */
int x = 42; //x is a integer variable
printf("%d", x);
return 0;}

Por que você precisa de comentários?

Um bom programador que escreve códigos compreendidos por um ser humano é melhor do que um programador que gera códigos compreendidos apenas pela máquina.

Portanto, é altamente recomendável inserir comentários em seu código porque é uma boa prática de programação. Os comentários não afetam um programa porque o compilador os ignora.

Os comentários ajudam o desenvolvedor a entender a lógica/algoritmo do código se ele o revisitar depois de muito tempo.