La lecture du code ne serait-elle pas beaucoup plus facile si l'auteur partageait constamment ses réflexions avec vous ? Commenter est une bonne pratique en Python parce que cela aide les autres (et votre futur moi) à comprendre votre code beaucoup mieux. Écrire du code commenté vous rend plus productif à long terme !
Il existe deux types de commentaires :commentaires d'une ligne et commentaires sur plusieurs lignes . Plongeons-y directement !
Commentaires d'une ligne
Commentaires d'une ligne commencer par le dièse (# ) caractère et atteindre la fin de la ligne. Le caractère de nouvelle ligne termine la signification du commentaire, ce qui permet à l'interpréteur Python d'ignorer le texte commenté. Un cas particulier sont les commentaires intégrés qui sont utilisés après une instruction Python normale mais avant le caractère de saut de ligne. La norme PEP 8 recommande de les utiliser avec parcimonie.
# This is a one-line comment
print('hi') # This is an inline comment Commentaires multi-lignes
Alors que les commentaires sur une ligne se terminent à la fin de la ligne, les commentaires sur plusieurs lignes s'étendent sur plusieurs lignes pour décrire le code plus en détail. Il existe deux manières de créer des commentaires multilignes :(1) en plaçant le texte du commentaire entre guillemets triples """ ou ''' pour créer une chaîne de documentation, ou (2) créer un commentaire de bloc en utilisant plusieurs hachages # caractères, un par ligne. Selon la norme PEP 8, les commentaires multi-lignes doivent être évités.
# 1. Multi-Line Comment: Documentation String
def say_hi():
'''Print the string 'hi'
to the shell.'''
print('hi')
# 2. Multi-Line Comment: Block Comment
# This is still a comment. It's
# called 'Block Comment'. Exercice :Utilisez les commentaires pour corriger ce code erroné
L'extrait de code suivant est défectueux.
Exercice :Utilisez des commentaires sur une ligne, des commentaires en ligne, des commentaires de bloc ou des chaînes de documentation pour corriger ce code. Exécutez le code pour vérifier si la sortie est :
Comments are great!
Vous trouverez la bonne solution à la fin de cet article !
