Les commentaires en Python
Les commentaires en Python
-
Objectifs
- Etre capable de commenter votre code en Python
-
Introduction
- Les commentaires sont des lignes qui existent dans les programmes informatiques et qui sont ignorées par les compilateurs et les interprètes.
- L’inclusion de commentaires dans les programmes rend le code plus lisible pour les humains car il fournit des informations ou des explications sur ce que fait chaque partie d’un programme.
- Lorsque vous travaillez avec un langage de programmation, vous incluez des commentaires dans le code pour noter votre travail.
- Cela détaille à quoi servent certaines parties du code et permet aux autres développeurs – vous y compris – de savoir ce que vous faisiez lorsque vous avez écrit le code.
- C’est une pratique nécessaire, et les bons développeurs font un usage intensif du système de commentaires. Sans cela, les choses peuvent devenir vraiment déroutantes, très vite.
-
Comment écrire des commentaires en Python
- En Python, il existe deux façons d’annoter votre code.
-
La première méthode
- La première consiste à inclure des commentaires qui détaillent ou indiquent ce que fait une section de code – ou un extrait de code -.
- Les commentaires débutent toujours par le symbole # suivi d’un espace.
- Ils donnent des explications sur l’utilité du code et doivent être synchronisés avec le code, c’est-à-dire que si le code est modifié, les commentaires doivent l’être aussi.
- Pour une meilleure lisibilité des programmes, il faut le documenter. On insère des commentaires en utilisant le caractère # en début de commentaire :
- Tous les caractères qui suivent le dièse, jusqu’au retour à la ligne, sont ignorés lors de l’exécution du programme.
- Exemple de script commenté
- Les commentaires sont sur le même niveau d’indentation que le code qu’ils commentent.
- Soyez également cohérent entre la langue utilisée pour les commentaires et la langue utilisée pour nommer les variables.
-
La deuxième méthode
- La deuxième utilise des commentaires ou des paragraphes sur plusieurs lignes qui servent de documentation aux autres lisant votre code.
- Les commentaires qui s’étendent sur plusieurs lignes sont créés en ajoutant un délimiteur (""") à chaque extrémité du commentaire.
- Remarque:
- La méthode recommandée pour commenter plusieurs lignes consiste à utiliser # sur chaque ligne.
- La méthode (""") n’est pas en fait un commentaire mais définit une constante Texte du texte entre les ("""). Il n’est pas affiché, mais existe et pourrait potentiellement provoquer des erreurs inattendues.
-
Utilisation des commentaires
- Étant donné que les commentaires ne s’exécutent pas, lorsque vous exécutez un programme, vous ne verrez aucune indication du commentaire. Les commentaires sont dans le code source pour que les humains les lisent, pas pour que les ordinateurs les exécutent.
- Les commentaires doivent être faits avec le même retrait que le code qu’il commente. Autrement dit, une définition de fonction sans retrait aurait un commentaire sans retrait, et chaque niveau de retrait suivant aurait des commentaires alignés sur le code qu’il commente.
- Les commentaires sont faits pour aider les programmeurs, que ce soit le programmeur d’origine ou quelqu’un d’autre qui utilise ou collabore sur le projet.
- Lorsque vous commentez du code, vous devez chercher à répondre au pourquoi du code par opposition au quoi ou au comment .
-
Conclusion
- L’utilisation de commentaires dans vos programmes Python aide à rendre vos programmes plus lisibles pour les humains, y compris pour vous-même. Inclure des commentaires appropriés, pertinents et utiles, peut faciliter la collaboration d’autres personnes avec vous sur des projets de programmation et rendre la valeur de votre code plus évidente.
# ceci est un script commenté
print("Bonjour") # cette instruction affiche le mot Bonjour
print("Le commentaire précédent n'est pas affiché")"""
Ce serait un commentaire sur plusieurs lignes
en Python qui s'étend sur plusieurs lignes et
décrit votre code, votre journée ou tout ce que vous voulez
"""
