Dans cet article, nous approfondirons le concept de commentaires multilignes en Python, en fournissant une définition complète ainsi que des exemples illustratifs dans le langage de programmation Python sur Comment commenter plusieurs lignes dans Python .

Qu'est-ce qu'un commentaire multiligne en Python ?

Les commentaires multilignes en Python font référence à un bloc de texte ou à des instructions utilisées à des fins explicatives ou de documentation dans le code. Contrairement aux commentaires sur une seule ligne désignés par le symbole dièse (#), les commentaires sur plusieurs lignes sont entourés de guillemets triples (``) ou de guillemets simples triples (`’`). Ces commentaires sont souvent utilisés pour fournir des explications détaillées, de la documentation ou des notes sur le code, et ils peuvent s'étendre sur plusieurs lignes. Bien que Python n'ait pas de syntaxe spécifique pour les commentaires multilignes, l'utilisation de guillemets triples produit un effet similaire, car l'interpréteur ignore le texte inclus.

Types de commentaires multilignes en Python

Il existe deux manières d’ajouter des commentaires multilignes Python dans notre code. Ils sont les suivants :

• Commentaire consécutif sur une seule ligne
• Utiliser une chaîne multiligne comme commentaire
• Utilisation de la méthode de barre oblique inverse

Commentez plusieurs lignes en Python à l'aide de commentaires consécutifs sur une seule ligne

Dans Python , le caractère dièse (#) est utilisé pour commenter la ligne. Une seule ligne commentaires en Python Il n'est pas nécessaire que ce soit uniquement du texte pour expliquer le code, ils peuvent également être utilisés pour empêcher Python d'exécuter du code. Le caractère dièse doit être placé avant chaque ligne pour être considéré comme un commentaire multiligne en Python.

Exemple : commentaire consécutif sur une seule ligne

Ici, les deux premières lignes contiennent un caractère dièse (#) et l'interpréteur empêche l'exécution des deux lignes. Ensuite, il imprime les commentaires Python et enfin, il empêchera l'exécution de la dernière ligne.

# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')>

Sortir:

Python Comments>

Commentez plusieurs lignes en Python en utilisant une chaîne multiligne comme commentaire

Les commentaires multilignes Python peuvent également être placés dans un délimiteur (). Encore une fois, il ne doit y avoir aucun espace blanc entre les délimiteurs (). Ils sont utiles lorsque le texte du commentaire ne tient pas sur une seule ligne et doit donc s'étendre sur plusieurs lignes. Ce type de chaîne littérale est ignoré car il n’est affecté à aucune variable. Nous pouvons accéder à ces chaînes en utilisant __doc__.

Exemple : utilisation d'une chaîne multiligne comme commentaire

Les commentaires sur plusieurs lignes sont utilisés pour commenter plusieurs lignes. La première ligne est un commentaire sur une seule ligne. Les deuxième et troisième lignes peuvent être commentées à l'aide de guillemets triples ( ). Cela empêche l'exécution du code ci-dessus. Enfin, il imprime les mathématiques dans la sortie. Cependant, si ces commentaires multilignes Python sont placés directement après une signature de fonction ou de classe, alors ceux-ci se transforment en docstrings .

# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')>

Sortir:

Mathematics>

Commentez plusieurs lignes en Python à l'aide de la méthode Backslash

Une méthode pour créer des commentaires multilignes en Python consiste à utiliser la barre oblique inverse (``) à la fin de chaque ligne pour utiliser la fonction de continuation de ligne, permettant ainsi au commentaire de s'étendre jusqu'à la ligne suivante. Cette méthode de continuation de ligne est moins courante que d'autres approches telles que les commentaires consécutifs sur une seule ligne ou les chaînes multilignes et est principalement utilisée à des fins de lisibilité du code lorsqu'il est nécessaire de diviser un commentaire sur plusieurs lignes.

Exemple : Dans cet exemple, les commentaires commençant par#>sont étendus à plusieurs lignes à l'aide de la barre oblique inverse (>) à la fin de chaque ligne. La barre oblique inverse indique que le commentaire continue sur la ligne suivante. Cette méthode peut être utile pour améliorer la lisibilité du code lorsque vous avez de longs commentaires.

# Using backslash for multiline comments # This is a long comment  # that spans multiple lines  # using the backslash continuation method. # Code continues below print('Hello, World!')>

Sortir :

Hello, World!>

Docstrings en Python

Le chaîne de documentation est une fonctionnalité intégrée de Python, utilisée 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 le Python __doc__ attribut.

Exemple : Docstrings en Python

Dans cet exemple, une fois la fonction multiplier() définie, nous avons déclaré un commentaire docstring en utilisant les guillemets triples. Ensuite, nous imprimons la docstring en utilisant l'attribut __doc__.

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>

Différence entre les commentaires et Docstring en Python

Voyons la différence entre les commentaires Python et Docstring :