Chaque langage de programmation fournit un mécanisme pour ajouter des commentaires aux projets. Les commentaires sont les lignes simples des programmes informatiques qui sont ignorées par le compilateur ou l'interpréteur. Les commentaires sont souvent écrits en langage naturel pour améliorer la compréhension du programmeur. Les développeurs utilisent des commentaires pour ignorer certaines parties du code lors de la phase de débogage ou de test.
Écrire des commentaires en Python peut être très simple, et la création d'un commentaire en Python commence par le symbole '#'. Cet article explique comment créer des commentaires multilignes en Python.
Écrire des commentaires multilignes en Python
Contrairement à de nombreux autres langages de programmation, Python ne fournit aucun moyen spécifique d'écrire des commentaires sur plusieurs lignes. Néanmoins, il existe d'autres moyens de faire face à ce problème.
En java, nous écrivons plusieurs commentaires comme suit :
/ *
Ci-dessus, nous écrivons un commentaire sur plusieurs lignes.
Ce format de commentaire ne fonctionne pas en Python.
* /
La méthode ci-dessus pour écrire des commentaires ne fonctionne pas non plus en Python.
Voyons d'autres façons d'écrire des commentaires multilignes en Python.
Utilisation de plusieurs commentaires de ligne de symboles
Le symbole '#' est utilisé pour écrire le commentaire d'une seule ligne de Python. Avec plusieurs commentaires consécutifs sur une seule ligne, nous pouvons écrire des commentaires sur plusieurs lignes. Voyons un exemple de cela.
#Bonjour à tous
#ceci est un commentaire en Python
#j'écris des commentaires sur plusieurs lignes
#en utilisant le commentaire sur une seule ligne
C'est une façon d'écrire des commentaires multilignes. C'est un processus un peu long, car il nous oblige à rédiger plusieurs commentaires sur une seule ligne.
Voyons maintenant d'autres façons d'écrire des commentaires multilignes en Python.
Utilisation de littéraux de chaîne pour écrire des commentaires sur plusieurs lignes
Comme indiqué précédemment, Python ne fournit pas un moyen réel d'écrire des commentaires multilignes, mais vous pouvez utilisez des littéraux de chaîne pour écrire des commentaires sur plusieurs lignes. L'interpréteur Python ignore les chaînes littérales qui ne sont allouées à aucune variable et ne les exécute pas. Ainsi, vous pouvez utiliser des littéraux de chaîne non affectés pour écrire des commentaires multilignes en Python. Regardons un exemple de ceci.
'Nous utilisons le littéral de chaîne comme commentaire'« Ceci est un commentaire sur plusieurs lignes »
« Nous imprimons le programme hello world »
print('Bonjour tout le monde')
Sortir
Dans la sortie, vous pouvez voir que l'interpréteur Python ne génère aucune erreur et imprime le message 'Hello World'.
Utilisation de littéraux de chaîne entre guillemets triples pour écrire des commentaires sur plusieurs lignes
Bien que les littéraux de chaîne entre guillemets triples soient principalement utilisés pour écrire des docstrings, vous pouvez également utiliser cet outil pour écrire des commentaires sur plusieurs lignes. Assurez-vous de ne pas confondre la docstring avec les littéraux de chaîne entre guillemets triples qui sont utilisés pour écrire des commentaires sur plusieurs lignes. Une indentation incorrecte des littéraux de chaîne entre guillemets triples générera une erreur. Regardons un exemple de ceci.
'' 'Nous utilisons les littéraux de chaîne entre guillemets triples pour les commentaires multilignes
Le langage de programmation est Python
Imprimons le bonjour le monde
'' '
print('Bonjour tout le monde')
Sortir
Dans la sortie, vous pouvez voir que l'interpréteur Python ne génère aucune erreur et imprime le message 'Hello World'.
Maintenant, utilisons les littéraux de chaîne entre guillemets triples dans une fonction pour écrire des commentaires sur plusieurs lignes.
Dans l'exemple donné, nous imprimons la somme de deux nombres.
def cal_sum() :'' '
nous calculons la somme de deux nombres.
C'est un programme de somme
'' '
nombre1=10
num2=20
print('La somme est : ',num1+num2)
'' '
Fonction principale Python
'' '
def principal() :
somme_cal()
if __name__ == '__main__' :
principale()
Sortir
Maintenant, changeons l'indentation et dans la sortie, vous verrez que l'interpréteur génère une erreur.
def cal_sum() :'' '
On calcule la somme des deux nombres.
C'est un programme de somme
'' '
nombre1=10
num2=20
print('La somme est : ',num1+num2)
'' '
Fonction principale Python
'' '
def principal() :
somme_cal()
if __name__ == '__main__' :
principale()
Sortir
L'interpréteur génère l'erreur d'indentation.
Conclusion
Cet article explique comment créer des commentaires multilignes dans le langage de programmation Python. Bien que Python ne fournisse aucun moyen réel d'écrire des commentaires sur plusieurs lignes, vous pouvez résoudre ce problème en utilisant les différentes méthodes décrites dans cet article.