Commentaires en Python sont les lignes du code qui sont ignorées par l'interpréteur lors de l'exécution du programme.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
Les commentaires améliorent la lisibilité du code et aident les programmeurs à comprendre très attentivement le code. Cela facilite également la collaboration avec d'autres développeurs, car l'ajout de commentaires facilite l'explication du code.
Types de commentaires en Python
Il existe trois types de commentaires en Python :
- Commentaires sur une seule ligne
- Commentaires multilignes
- Littéraux de chaîne
- Commentaires sur la chaîne de documents
Commentaires en Python
Dans l'exemple, on peut voir que Python Les commentaires sont ignorés par l'interprète lors de l'exécution du programme.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Sortir:
geeksforgeeks>
Pourquoi les commentaires sont-ils utilisés en Python ?
Les commentaires font partie intégrante des langages de programmation, et chaque langage a des manières différentes d'utiliser les commentaires.
Comme dans tout autre langage, les commentaires en Python ont pour objectif suivant :
- Améliorer la lisibilité du code
- Expliquer le code aux autres
- Comprendre le code s'il est étudié après un certain temps
- Documenter les étapes et les besoins d'une fonction
- Partager du code avec d'autres développeurs
- Collaborer avec plusieurs personnes.
Types de commentaires en Python
Découvrons les différents types de commentaires, comment les utiliser et quand les utiliser ?
1. Ligne unique commentaires
- Le commentaire Python sur une seule ligne commence par le symbole hashtag (#) sans espaces blancs et dure jusqu'à la fin de la ligne.
- Si le commentaire dépasse une ligne, mettez un hashtag sur la ligne suivante et continuez le commentaire Python.
- Les commentaires sur une seule ligne de Python se révèlent utiles pour fournir de brèves explications sur les variables, les déclarations de fonctions et les expressions. Consultez l’extrait de code suivant illustrant un commentaire sur une seule ligne :
Exemple:
Python3
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
Nick Pulos éclair noir
>
>Sortir
techcodeview.com>
2. Commentaires sur plusieurs lignes
Python ne fournit pas l'option pour commentaires multilignes . Cependant, il existe différentes manières d’écrire des commentaires sur plusieurs lignes.
a) Commentaires multilignes utilisant plusieurs hashtags (#)
Nous pouvons utiliser plusieurs hashtags (#) pour écrire des commentaires multilignes en Python. Chaque ligne sera considérée comme un commentaire sur une seule ligne.
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>Sortir
Multiline comments>
Vérifiez également : Fait intéressant sur les commentaires multilignes Python
3. Littéraux de chaîne
Python ignore le chaînes littérales qui ne sont pas affectés à une variable afin que nous puissions utiliser ces chaînes littérales comme commentaires Python .
a) Commentaires sur une seule ligne utilisant des chaînes littérales
En exécutant le code ci-dessus, nous pouvons voir qu'il n'y aura aucune sortie, nous utilisons donc les chaînes avec guillemets triples () sous forme de commentaires multilignes.
Python3
'This will be ignored by Python'> |
>
>
b) Commentaires multilignes utilisant des chaînes littérales
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
>Sortir
Multiline comments>
4. Docstring
- Chaîne de documentation Python sont les chaînes littérales avec des guillemets triples qui apparaissent juste après la fonction.
- Il est utilisé pour associer la documentation écrite avec des modules, fonctions, classes et méthodes Python.
- Il est ajouté juste en dessous des fonctions, modules ou classes pour décrire ce qu'ils font. En Python, la docstring est ensuite mise à disposition via l'attribut __doc__.
Exemple:
Python3
def> multiply(a, b):> >'''Multiplies the value of a and b'''> >return> a>*>b> > > # Print the docstring of multiply function> print>(multiply.__doc__)> |
>
>
Sortir:
Multiplies the value of a and b>
Avantages des commentaires en Python
Les commentaires sont généralement utilisés aux fins suivantes :
- Lisibilité du code
- Explication du code ou des métadonnées du projet
- Empêcher l'exécution du code
- Pour inclure des ressources
Bonne façon d'écrire des commentaires
Les commentaires ont pour objectif principal d'expliquer votre code. Les développeurs utilisent des pratiques saines de rédaction de commentaires pour une meilleure compréhension du code.
Certains des conseils que vous pouvez suivre pour rendre vos commentaires efficaces sont :
- Les commentaires doivent être courts et précis.
- Utilisez les commentaires uniquement lorsque cela est nécessaire, n'encombrez pas votre code de commentaires.
- Le commentaire doit avoir un sens.
- Évitez d'écrire des commentaires génériques ou basiques.
- Écrivez des commentaires explicites.
Nous avons tout discuté des commentaires Python, de la façon d'écrire des commentaires Python, des types de commentaires, de leurs avantages et de la bonne façon d'écrire des commentaires.
Lire aussi : Comment écrire des commentaires en Python3 ?