Comment commenter un bloc de code en Python

Les commentaires sont l’un des outils les plus utiles quand on travaille avec Python. Ils nous guident à travers la logique, les décisions et les buts derrière les blocs de code sans interférer avec l’exécution. Les commentaires aident à rendre le code plus lisible et plus facile à maintenir et facilitent la collaboration dans un environnement de équipe.

Ce tutoriel se plongera dans deux méthodes efficaces pour commenter plusieurs lignes de code en Python, garantissant que votre code est bien documenté et facile à comprendre.

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

Les commentaires sont souvent l’une des premières concepts que vous rencontrez dans votre voyage d’apprentissage de Python. Ils fournissent un contexte utile sur l’intention derrière un certain snippet de code. Ils offrent de la clarté et du contexte sur pourquoi un script se comporte comme il le fait. Il existe une variété d’importantes raisons pour lesquelles vous devriez toujours utiliser des commentaires dans vos scripts. Voici quatre d’entre elles :

• Documentation : Les commentaires agissent comme une forme de documentation expliquant le but des fonctions, des classes ou des blocs de code. Cela est particulièrement utile pour les algorithmes complexes où la logique peut ne pas être immédiatement apparente.
• Lisibilité : Un code commenté bien est plus facile à lire et à comprendre. C’est crucial lorsque vous ou d’autres retournez au code après un certain temps.
• Débogage : Commenter temporairement des sections de code est une pratique courante pour isoler et identifier les bugs.
• Collaboration : Dans un environnement de équipe, les commentaires rendent le code plus partageable et compris, facilitant ainsi une collaboration plus fluide et les examens de code.

Utilisation de commentaires de bloc en ligne unique en Python

Avant de nous plonger dans le commentage de plusieurs lignes, commençons par les bases des commentaires de ligne unique. En Python, un commentaire de ligne unique commence avec le symbole du caractère numéro (#), et l’interpréteur Python ignore tout ce qui suit sur cette ligne. Pour créer un commentaire de ligne unique, 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, à droite du code sur la même ligne ou en isolation.
2. Contenu : Après le symbole #, écrivez votre commentaire. Cela peut être une explication de la ligne de code, une note pour les futurs utilisateurs ou toute information utile liée au code.

# Ceci est un commentaire de ligne unique expliquant la ligne de code suivante
print("Hello, world!")  # Cela affiche un message sur la console

Méthode #1 : Commenter en utilisant plusieurs lignes de commentaires simples #

Le moyen le plus simple de commenter en Python consiste à utiliser le symbole #, qui commente tout ce qui le suit sur la ligne. Bien que Python n’ait pas de syntaxe spécifique pour les commentaires de bloc, vous pouvez utiliser plusieurs symboles # pour commenter chaque ligne individuellement. Voici ce que vous devez faire :

1. Identifier 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 n’importe quel segment de code que vous souhaitez désactiver ou expliquer.
2. Commenter chaque ligne : Placez un 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.

Voici un exemple ci-dessous :

# Exemple de commentaires de plusieurs lignes individuellement
# def example_function(name):
#	# Cette fonction affiche "Hello " et le nom entré
# 	print("Hello", name)

Méthode de commentaire de bloc en Python #2 : Commenter en utilisant les littéraux de chaîne de triple guillemets

Une méthode alternative pour commenter plusieurs lignes est d’utiliser des littéraux de chaîne de caractères triples ( »’  »’ ou «  » » «  » »). Bien que ceux-ci ne soient pas officiellement des commentaires blocs, ils sont souvent utilisés comme tels, en particulier pour les commentaires multi-lignes ou les docstrings. Pour utiliser des chaînes de caractères triples, 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 littéraux de chaîne de caractères triples sont principalement utilisés pour documenter les fonctions Python. Par exemple :

# Créer 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"
	'''
	# Afficher la sortie
	print("Hello", name)

Ces littéraux de chaîne de caractères triples sont appelés docstrings — vous pouvez en savoir plus sur eux dans notre tutoriel docstrings.