Dans ce tutoriel, nous allons apprendre à créer des commentaires en Python à l'aide d'exemples.
Vidéo: Commentaires en Python
Les commentaires sont des descriptions qui aident les programmeurs à mieux comprendre l'intention et la fonctionnalité du programme.
Ils sont complètement ignorés par l'interpréteur Python.
Avantages de l'utilisation des commentaires
L'utilisation de commentaires dans les programmes rend notre code plus compréhensible. Cela rend le programme plus lisible, ce qui nous aide à nous rappeler pourquoi certains blocs de code ont été écrits.
En dehors de cela, les commentaires peuvent également être utilisés pour ignorer du code tout en testant d'autres blocs de code. Cela offre un moyen simple d'empêcher l'exécution de certaines lignes ou d'écrire un pseudo-code rapide pour le programme.
Commentaires sur une seule ligne en Python
En Python, nous utilisons le symbole de hachage #pour écrire un commentaire sur une seule ligne.
Exemple 1: Rédaction de commentaires sur une seule ligne
# printing a string print('Hello world')
Production
Bonjour le monde
Ici, le commentaire est:
# printing a string
Cette ligne est ignorée par l'interpréteur Python.
Tout ce qui vient après #est ignoré. Ainsi, nous pouvons également écrire le programme ci-dessus sur une seule ligne sous la forme:
print('Hello world') #printing a string
La sortie de ce programme sera la même que dans l' exemple 1 . L'interprète ignore tout le texte après #.
Commentaires multilignes en Python
Python n'offre pas un moyen distinct d'écrire des commentaires multilignes. Cependant, il existe d'autres moyens de contourner ce problème.
On peut utiliser #au début de chaque ligne de commentaire sur plusieurs lignes.
Exemple 2: Utilisation de plusieurs #
# it is a # multiline # comment
Ici, chaque ligne est traitée comme un seul commentaire et tous sont ignorés.
Littéraux de chaîne pour les commentaires sur plusieurs lignes
Même s'il n'y a pas de moyen unique d'écrire des commentaires multilignes en Python, nous savons que l'interpréteur Python ignore les littéraux de chaîne qui ne sont pas affectés à une variable.
Ainsi, nous pouvons même écrire un commentaire sur une seule ligne comme:
#this is a comment 'this is an unassigned string as a comment '
Ici, nous pouvons voir que la deuxième ligne du programme est une chaîne mais n'est assignée à aucune variable ou fonction. Ainsi, l'interpréteur ignore la chaîne.
De la même manière, nous pouvons utiliser des chaînes multilignes (guillemets triples) pour écrire des commentaires multilignes.
Le caractère de citation peut être 'ou ".
Exemple 3: Utilisation de chaînes littérales pour écrire des commentaires sur plusieurs lignes
''' I am a multiline comment! ''' print("Hello World")
Ici, la chaîne multiligne n'est affectée à aucune variable, elle est donc ignorée par l'interpréteur. Même s'il ne s'agit pas techniquement d'un commentaire multiligne, il peut être utilisé comme un seul.
Docstrings Python
Par convention, les triples guillemets qui apparaissent juste après la définition de la fonction, de la méthode ou de la classe sont des docstrings (chaînes de documentation).
Les docstrings sont associés aux objets et sont accessibles à l'aide de l' __doc__attribut.
Pour en savoir plus, visitez les docstrings Python.
Comment rédiger de meilleurs commentaires?
- Utilisez des commentaires pour décrire ce que fait une fonction et non les détails spécifiques sur la façon dont la fonction le fait.
- Essayez de supprimer autant de commentaires redondants que possible. Essayez d'écrire du code qui peut s'expliquer, en utilisant un meilleur choix de nom de fonction / variable.
- Essayez de rendre les commentaires aussi brefs et concis que possible.
