Commenter un bloc de code en Python

1. Ajoutez # avant chaque ligne pour commenter plusieurs lignes en Python
2. Utiliser des guillemets triples pour les commentaires multilignes en Python
3. Utilisez if False: pour les commentaires multilignes en Python
4. Utiliser une variable chaîne pour les commentaires multilignes en Python
5. Utiliser un éditeur de code pour les commentaires multilignes en Python

Dans ce didacticiel, nous discuterons des méthodes pour commenter plusieurs lignes de code en Python.

Ajoutez # avant chaque ligne pour commenter plusieurs lignes en Python

Le # est utilisé pour les commentaires sur une seule ligne en Python. Malheureusement, il n’y a pas de méthode par défaut pour commenter plusieurs lignes de code en Python. Pour commenter plusieurs lignes de code en utilisant le #, nous devons ajouter un # avant chaque ligne. L’exemple de code suivant nous montre comment utiliser # pour commenter plusieurs lignes de code en Python.

# Hello! this is a
# Multiple line comment
# print("This is a comment")
print("This is not a comment")

Production:

This is not a comment

Dans le code ci-dessus, nous avons commenté les 3 premières lignes de code en utilisant # avant chaque ligne. Cette approche convient pour moins de lignes, mais ce processus peut devenir très laborieux si nous avons un grand nombre de lignes.

Utiliser des guillemets triples pour les commentaires multilignes en Python

Les guillemets triples sont utilisés pour la documentation du code et ne sont pas exécutés pendant l’exécution du code. L’exemple de code suivant nous montre comment utiliser des guillemets triples pour commenter plusieurs lignes de code en Python.

"""
Hello! this is a 
Multiple line comment
print("This is a comment")
"""
print("This is not a comment")

Production:

This is not a comment

Dans le code ci-dessus, nous avons commenté les 3 premières lignes de code en les mettant entre guillemets triples. Les triples guillemets réduisent considérablement l’effort. Mais les guillemets triples sont conçus pour être utilisés pour la documentation du code et ne doivent pas être utilisés pour commenter le code.

Utilisez if False: pour les commentaires multilignes en Python

Une autre approche qui peut être utilisée pour commenter plusieurs lignes de code en Python est l’instruction if False:. Tout ce qui est écrit dans ce bloc de code n’est jamais exécuté car il n’est jamais False dans ce contexte. Nous devons juste écrire if False: avant le bloc de code que nous voulons commenter puis indenter notre code à l’intérieur de l’instruction if. L’exemple de code suivant nous montre comment utiliser if False: pour commenter plusieurs lignes de code en Python.

if False:
    print("This is a comment")
    print("This is another comment")
print("This is not a comment")

Production:

This is not a comment

Dans le code ci-dessus, nous avons commenté 2 lignes de code en utilisant if False:. Le seul problème avec cette approche est qu’elle ne peut commenter qu’un bloc de code avec une syntaxe appropriée. L’interpréteur détectera toujours les erreurs de syntaxe dans ce bloc de code.

Utiliser une variable chaîne pour les commentaires multilignes en Python

Une variable chaîne peut être utilisée pour y stocker plusieurs lignes de code. Nous pouvons utiliser des guillemets triples pour stocker plusieurs lignes de code dans une variable chaîne. L’exemple de code suivant nous montre comment utiliser une variable de chaîne pour commenter plusieurs lignes de code en Python.

comments = "This is a variable for commenting"
comments = """Hello! this is a 
Multiple line comment
print("This is a comment")"""
print("This is not a comment")

Production:

This is not a comment

La même variable peut être utilisée plusieurs fois pour commenter plusieurs blocs de code en Python.

Utiliser un éditeur de code pour les commentaires multilignes en Python

Nous avons discuté de nombreuses approches qui peuvent être utilisées pour commenter plusieurs lignes de code en Python. Mais, malheureusement, aucune des approches ci-dessus n’est une solution optimale. La meilleure solution pour cette tâche serait d’utiliser les raccourcis clavier de l’éditeur de code souhaité pour commenter plusieurs lignes de code en Python.

Code Visual Studio

Dans Visual Studio Code, sélectionnez le bloc de code et utilisez Ctrl+k, Ctrl+c pour commenter et Ctrl+k, Ctrl+u pour décommenter.

Notepad++

Dans Notepad++, sélectionnez le bloc de code et utilisez Ctrl+k pour commenter.

PyCharm

Dans Pycharm IDE, sélectionnez le bloc de code et utilisez Ctrl+/ pour commenter et décommenter.

Quel que soit l’éditeur de code que vous utilisez, il a un moyen de commenter plusieurs lignes de code. Tout ce que vous avez à faire est de rechercher le raccourci clavier pour commenter plusieurs lignes.