Cómo escribir comentarios en programación C

¿Qué es un comentario en lenguaje C?

A comentario es una explicación o descripción del código fuente del programa. Ayuda al desarrollador a explicar la lógica del código y mejora la legibilidad del programa. En tiempo de ejecución, el compilador ignora un comentario.

Hay dos tipos de comentarios en C:

1) Un comentario que comienza con una barra asterisco /* y termina con una barra asterisco */ y puedes colocarlo en cualquier lugar de tu código, en la misma línea o en varias líneas.

2) Comentarios de una sola línea que utilizan una doble barra // dedicada a comentar líneas individuales

Ejemplo de comentario de una sola línea

// single line comment example

Aquí hay un ejemplo de tipo de comentarios.

// 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
}

Ejemplo de comentario de varias líneas

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

Ejemplo de comentario de varias líneas

#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 qué necesitas comentarios?

Un buen programador que escribe códigos que entiende un humano es mejor que un programador que genera códigos que sólo entiende una máquina.

Por lo tanto, se recomienda encarecidamente insertar comentarios en el código porque es una buena práctica de programación. Los comentarios no afectan un programa porque el compilador los ignora.

Los comentarios ayudan al desarrollador a comprender la lógica/algoritmo del código si lo vuelve a visitar después de mucho tiempo.