Commentaires Multilignes (DocStrings)

Fondamental

Absence de Syntaxe Dédiée : Python n'a pas de syntaxe spécifique pour les commentaires multilignes comme /* ... */ que l'on trouve dans d'autres langages.

MéthodeMéthode 1 : Plusieurs #

Pour ajouter un commentaire sur plusieurs lignes, vous pouvez insérer un # au début de chaque ligne :

1
# Ceci est un commentaire
2
# écrit sur
3
# plus qu'une simple ligne.

MéthodeMéthode 2 : Chaînes de Caractères Multilignes (DocStrings)

Vous pouvez utiliser une chaîne de caractères multiligne (délimitée par des triples guillemets """...""" ou '''...'''). Si cette chaîne n'est pas affectée à une variable et qu'elle est placée à certains endroits spécifiques (comme la première instruction d'un module, d'une fonction, ou d'une classe), elle est traitée comme une chaîne de documentation (DocString). Si elle est placée ailleurs et non affectée, Python l'ignore.

1
"""
2
Ceci est un commentaire
3
écrit en
4
plus qu'une simple ligne, utilisant une chaîne multiligne.
5
"""
6
x = 10 # Le code continue ici
7
8
'''
9
Autre exemple de
10
commentaire multiligne.
11
'''
12
print(x)
  • Tant que la chaîne n'est pas affectée à une variable et n'est pas à une position où elle est interprétée comme une docstring officielle, Python lira le code mais l'ignorera ensuite, ce qui en fait un commentaire multiligne de facto.