Comment commenter un bloc de code en Python

Les commentaires sont l'un des outils les plus utiles lorsque vous travaillez avec Python. Ils nous guident dans la logique, les décisions et les objectifs qui se cachent derrière les blocs de code sans interférer avec l'exécution. Les commentaires permettent de rendre le code plus lisible et plus facile à maintenir et facilitent la collaboration au sein d'une équipe.

Ce tutoriel présente deux méthodes efficaces pour commenter plusieurs lignes de code en Python, afin de s'assurer que votre code est bien documenté et facilement compréhensible.

Pourquoi les blocs de commentaires sont-ils importants en Python ?

Les commentaires sont souvent l'un des premiers concepts que vous rencontrez dans votre apprentissage de Python. Ils fournissent un contexte utile sur l'intention qui se cache derrière un certain extrait de code. Ils permettent de comprendre pourquoi un texte se comporte comme il le fait. Il y a plusieurs raisons importantes pour lesquelles vous devez toujours utiliser des commentaires dans vos scripts. En voici quatre :

• Documentation: Les commentaires constituent une forme de documentation expliquant l'objectif des fonctions, des classes ou des blocs de code. Ceci est particulièrement utile pour les algorithmes complexes dont la logique n'est pas toujours évidente.
• Lisibilité: Un code bien commenté est plus facile à lire et à comprendre. Ceci est crucial lorsque vous ou d'autres personnes revisitent le code après un certain temps.
• Débogage: Le fait de commenter temporairement des sections de code est une pratique courante pour isoler et identifier les bogues.
• Collaboration: Dans un environnement d'équipe, les commentaires rendent le code plus facile à partager et à comprendre, ce qui facilite la collaboration et les révisions de code.

Utilisation de blocs de commentaires d'une seule ligne en Python

Avant de nous plonger dans le commentaire de plusieurs lignes, commençons par les bases du commentaire d'une seule ligne. En Python, un commentaire sur une seule ligne commence par le symbole du dièse (#), et l'interprète Python ignore tout ce qui suit sur cette ligne. Pour créer un commentaire d'une seule ligne, suivez les instructions ci-dessous :

1. Placement: Placez le symbole # au début de la ligne ou après le code sur la même ligne. Les commentaires peuvent être placés au-dessus du code qu'ils décrivent, sur la même ligne à droite du code, ou être indépendants.
2. Contenu: Après le symbole #, écrivez votre commentaire. Il peut s'agir d'une explication de la ligne de code, d'une note pour référence future ou de toute autre information utile relative au code.

# This is a single-line comment explaining the next line of code
print("Hello, world!")  # This prints a message to the console

Méthode n° 1 : Commentez en utilisant plusieurs # d'une seule ligne

La façon la plus simple de commenter en Python est d'utiliser le symbole #, qui met en commentaire tout ce qui le suit sur la ligne. Bien que Python n'ait pas de syntaxe spécifique pour les blocs de commentaires, vous pouvez utiliser plusieurs symboles # pour commenter chaque ligne individuellement. Il vous suffit de suivre les étapes suivantes :

1. Identifiez le bloc de code: Tout d'abord, identifiez le bloc de code que vous souhaitez commenter. Il peut s'agir d'une fonction, d'une boucle ou de tout segment de votre code que vous souhaitez désactiver ou expliquer.
2. Commentez chaque ligne: Placez le symbole # au début de chaque ligne que vous souhaitez commenter. Cela indique à l'interpréteur Python d'ignorer ces lignes pendant l'exécution.

Vous pouvez voir l'exemple ci-dessous :

# Example of commenting out multiple lines individually 
# def example_function(name):
#	# This function prints "Hello " and the input name
# 	print("Hello", name)

Méthode de commentaire en bloc Python #2 : Commentaire à l'aide de chaînes de caractères à triple guillemets

Une autre méthode pour commenter plusieurs lignes consiste à utiliser des chaînes de caractères entre trois guillemets (''' '''' ou """ ""). Bien qu'il ne s'agisse pas officiellement de commentaires de bloc, ces chaînes littérales sont souvent utilisées comme telles, en particulier pour les commentaires sur plusieurs lignes ou les chaînes de documentation. Pour utiliser des chaînes de caractères entre trois guillemets, il suffit de placer ''' ou """ avant et après le bloc de code que vous souhaitez commenter, comme suit :

'''
def example_function(name):
	print("Hello", name)
'''

Les chaînes de caractères entre guillemets triples sont le plus souvent utilisées pour documenter les fonctions Python. Par exemple :

# Create example_function()
def example_function(name):
	'''
	This function takes as input a name, and returns a salutation to the name in the form of "Hello name"
	'''
	# Print the output 
	print("Hello", name)

Ces chaînes de caractères entre guillemets triples sont appelées docstrings - vous pouvez en savoir plus à ce sujet dans notre tutoriel sur les docstrings.