Comment écrire des commentaires en programmation C

Qu'est-ce qu'un commentaire en langage C ?

Un commentaire est une explication ou une description du code source du programme. Il aide un développeur à expliquer la logique du code et améliore la lisibilité du programme. Lors de l'exécution, un commentaire est ignoré par le compilateur.

Il existe deux types de commentaires en C :

1) Un commentaire qui commence par un slash astérisque /* et se termine par un astérisque slash */ et vous pouvez le placer n'importe où dans votre code, sur la même ligne ou sur plusieurs lignes.

2) Commentaires sur une seule ligne qui utilise une double barre oblique // dédiée aux commentaires sur une seule ligne

Exemple de commentaire sur une seule ligne

// single line comment example

Voici un exemple de type de commentaire

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

Exemple de commentaire sur plusieurs lignes

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

Exemple de commentaire sur plusieurs lignes

#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;} 

Pourquoi avez-vous besoin de commentaires ?

Un bon programmeur qui écrit des codes compris par un humain vaut mieux qu'un programmeur qui génère des codes compris uniquement par la machine.

Il est donc fortement recommandé d'insérer des commentaires dans votre code car c'est une bonne pratique de programmation. Les commentaires n'affectent pas un programme car le compilateur les ignore.

Les commentaires aident le développeur à comprendre la logique/l'algorithme du code s'il le revisite après une longue période.