Commentaires Python

Les commentaires sont les lignes d'un programme informatique qui aident à mieux comprendre les fonctionnalités du système. Dans n'importe quel langage de programmation, les commentaires sont écrits en langage naturel et d'une manière lisible par l'homme. Ils ne sont pas exécutés plutôt qu'ils sont ignorés par le compilateur ou l'interpréteur. Les commentaires en Python sont utilisés à diverses fins. Dans cet article, nous allons vous expliquer comment ajouter des commentaires en python.

Avantages de l'utilisation des commentaires en Python

Voici les avantages de l'utilisation des commentaires en Python :

Les commentaires rendent le code plus lisible : Lors du développement d'un programme informatique, le programmeur écrit plusieurs classes et des milliers de lignes de code. Parfois, le programmeur oublie pourquoi un certain morceau de code est écrit. Les commentaires rendent le code plus lisible et nous aident à nous rappeler pourquoi un morceau de code est ajouté et quel est son objectif.

Les commentaires améliorent la compréhension du code : Les commentaires nous aident à comprendre pourquoi un certain bloc de code est ajouté dans le programme et à quoi il sert. Si un programmeur écrit un bloc de code, il ne peut pas ajouter les commentaires car il comprend le but d'écrire un bloc de code spécifique. Mais, si un autre programmeur veut mettre à jour le code, alors il n'est pas si facile pour lui de comprendre le code en quelques minutes. Ainsi, lorsque nous ajoutons les commentaires, cela aide les autres programmeurs à comprendre le code. Supposons que vous travaillez sur le projet Python. C'était le projet de taille moyenne initialement. Mais pour l'instant, votre entreprise doit améliorer ce projet et amener plus de développeurs et de programmeurs à écrire le code. Si vous n'avez pas écrit les commentaires dans votre programme, alors vous verrez qu'il leur sera très difficile de comprendre le code et cela prendra plus de temps. Mais si vous avez correctement écrit les commentaires avec chaque bloc de code, les développeurs nouvellement embauchés comprendront facilement le code existant. Initialement, la rédaction et la maintenance des commentaires prennent un certain temps, mais cela vous fera gagner beaucoup de temps à l'avenir.

Les commentaires favorisent la réutilisation du code : Lorsque nous développons des systèmes logiciels similaires, la réutilisation de l'existant est la meilleure pratique. Cela nous fait gagner beaucoup d'efforts et de temps. Tout en réutilisant le code, nous vérifions d'abord quels composants nous devons réutiliser. Nous devons comprendre la fonctionnalité du composant particulier. Les commentaires nous aident à comprendre la fonctionnalité du composant et favorisent la réutilisation du code.

Rédaction de commentaires en Python

Écrire les commentaires en Python est très facile. Les commentaires en Python commencent par le signe #. En python, nous utilisons trois types de commentaires :

1. Commentaires sur une seule ligne
2. Commentaires en ligne
3. Commentaires multi-lignes

Commentaires sur une seule ligne

Les commentaires d'une seule ligne sont écrits brièvement sur une seule ligne. Les commentaires d'une seule ligne transmettent le but d'écrire une fonction spécifique ou une ligne de code. Dans un programme simple, le commentaire est comme ceci :

Production

La sortie est imprimée sur la console Python. Dans la sortie, seul "Hello World" est imprimé. Le commentaire est ignoré par le compilateur.

Dans une boucle for, les commentaires sont comme ça

Commentaires en ligne

Les commentaires en ligne sont écrits à la fin de la ligne de code. Dans un simple programme "Hello World", le commentaire en ligne est comme ceci

Le commentaire en ligne dans une boucle for est comme ceci :

Commentaires multilignes

Python ne fournit pas de manière distincte d'écrire les commentaires multilignes. Nous pouvons écrire des commentaires multilignes en Java, C, C++ et C# mais en Python, il n'y a pas de moyen séparé d'écrire des commentaires multilignes. Les commentaires multilignes sont généralement utilisés pour expliquer des blocs de code complexes. Dans les commentaires multilignes, chaque ligne commence par la marque #. Si nous voulons écrire plusieurs lignes de commentaires, chaque ligne commencera par un signe # comme celui-ci :

Conclusion

Les commentaires sont très utiles dans le programme Python. Cela nous aide à comprendre le programme. Cela rend les programmes Python plus lisibles pour les humains. Les commentaires favorisent la réutilisation des programmes existants. Dans cet article, nous avons vu trois façons d'ajouter des commentaires en Python. En utilisant ces trois manières, vous pouvez rendre vos programmes python plus lisibles, compréhensibles et réutilisables.