Exemple d'ajout de commentaires dans 15 langages de programmation

Découvrez ce que sont les commentaires et pourquoi ils sont importants en programmation.

Nous aborderons également deux types de commentaires courants et la manière de les écrire dans 15 langages de programmation différents.

Qu’est-ce qu’un commentaire en programmation ?

En termes simples, les commentaires sont des morceaux de texte qui ne seront pas visibles par les utilisateurs finaux et qui sont destinés à la référence des personnes qui écrivent le code.

De manière un peu plus formelle, un commentaire est une description du fonctionnement d’un programme dans un format simple et lisible. Ils sont généralement utilisés à des endroits où une clarté supplémentaire doit être apportée au développeur qui lit le code. Cela permet donc d’améliorer la lisibilité du code et de réduire le temps et la communication nécessaires au transfert des connaissances.

Lecompilateur/interprète ignore simplement les commentaires dans votre code, ce qui n’a aucune incidence sur le résultat final de votre programme. En résumé, les commentaires sont une explication simple et lisible de certains éléments du code.

Types courants de commentaires

La plupart des langages de programmation prennent en charge deux types de commentaires.

Commentaire d’une seule ligne
Commentaires sur plusieurs lignes / Commentaires en bloc

Comme leur nom l’indique, les commentaires sur une seule ligne sont utiles lorsqu’il s’agit d’ajouter un petit texte sur une seule ligne, par exemple une condition particulière, une valeur constante qui nécessite une petite description. En revanche, les commentaires multilignes sont plus utiles lorsqu’il s’agit d’ajouter une plus grande quantité d’informations, comme une description d’une fonction et de la manière dont on peut l’utiliser, etc.

Il existe d’autres types de commentaires, comme les commentaires sur les documents, mais cela n’entre pas dans le cadre de cet article.

Pourquoi ajouter des commentaires ?

“N’importe quel idiot peut écrire un code qu’un ordinateur peut comprendre. Les bons programmeurs écrivent du code que les humains peuvent comprendre.” – Martin Fowler

Le principal avantage de l’ajout de commentaires est l’amélioration de la lisibilité et de la compréhension du programme. En dehors de cela, les autres avantages sont les suivants

Les commentaires permettent à vos collègues et même à d’autres développeurs de comprendre facilement la logique sans avoir à lire de longues documentations.
Réduction de la communication entre les développeurs pour les petits doutes
Les commentaires sont ignorés par le compilateur/interprète.
Pour les logiciels open source, ils sont indispensables car vous ne serez pas là pour expliquer chaque fonction à des millions de développeurs qui veulent utiliser ce programme particulier.

Commentaires dans plusieurs langues

Génial, maintenant que nous avons appris ce que sont les commentaires et pourquoi ils sont utiles. Voyons comment nous pouvons ajouter des commentaires dans différents langages de programmation.