Commentaires de code Python | Guide pour les débutants

Introduction

Les commentaires de code peuvent aider les personnes à comprendre le but du code, et de bonnes habitudes de commentaires sont essentielles pour un bon développeur. Dans ce lab (atelier), vous pouvez apprendre à ajouter des commentaires au langage Python et découvrir plusieurs méthodes courantes de commenter le code.

Réalisations

Commentaires de code

Skills Graph

%%%%{init: {'theme':'neutral'}}%%%% flowchart RL python(("Python")) -.-> python/BasicConceptsGroup(["Basic Concepts"]) python/BasicConceptsGroup -.-> python/strings("Strings") python/BasicConceptsGroup -.-> python/comments("Comments") subgraph Lab Skills python/strings -.-> lab-72{{"Commentaires de code Python"}} python/comments -.-> lab-72{{"Commentaires de code Python"}} end

Commentaires sur une seule ligne

En Python, le symbole # est utilisé pour les commentaires sur une seule ligne, qui peuvent apparaître au début ou à la fin d'une ligne de code.

Exemple

Ouvrez le fichier /home/labex/project/single.py dans votre éditeur de texte et ajoutez un commentaire sur une seule ligne :

## Output hello string
print('hello')

Alternativement, vous pouvez placer un commentaire à la fin de la ligne de code :

print('hello') ## Output hello string

Les commentaires sur une seule ligne sont précieux pour fournir des explications et des précisions dans votre code. Ils sont ignorés lors de l'exécution et servent de documentation utile à la fois pour vous-même et pour les autres.

Commentaires multilignes

Pour des commentaires plus longs, Python utilise trois apostrophes simples ''' ou trois guillemets doubles """ pour les commentaires multilignes.

Exemple

Ouvrez le fichier /home/labex/project/multi1.py dans votre éditeur de texte et ajoutez un commentaire multiligne en utilisant des apostrophes simples :

'''
This is a multi-line comment using single quotes.
It can be used to provide detailed explanations or instructions.
'''
name = "Tom"
print("Hello, " + name + "!")

Alternativement, ouvrez le fichier /home/labex/project/multi2.py dans un éditeur de texte et ajoutez un commentaire multiligne en utilisant des guillemets doubles :

"""
This is a multi-line comment using double quotes.
It can be used to provide detailed explanations or instructions.
"""
name = "Tom"
print("Hello, " + name + "!")

Les commentaires multilignes améliorent la lisibilité du code et sont particulièrement utiles lorsqu'il est nécessaire de fournir des explications détaillées. Ils servent de documentation précieuse au sein de votre code.

Résumé

Félicitations! Vous avez terminé le lab (atelier) sur les commentaires en Python.

Dans ce lab, vous avez appris à ajouter des commentaires sur une seule ligne et des commentaires multilignes en Python.