Option 2: Utiliser des chaînes Multi-lignes comme Commentaires

Une autre option pour écrire des commentaires multi-lignes « appropriés” en Python consiste à utiliser des chaînes multi-lignes avec la syntaxe """ de manière créative. Voici un exemple:

"""This is a "block comment" in Python, madeout of a mult-line string constant.This actually works quite well!"""answer = 42

comme vous pouvez le voir, vous pouvez utiliser des chaînes à trois guillemets pour créer quelque chose qui ressemble à un commentaire multiligne en Python., Il vous suffit de vous assurer d’indenter correctement le premier """, sinon vous obtiendrez un SyntaxError. Par exemple, si vous souhaitez définir un commentaire de bloc dans une fonction avec cette technique, vous devez le faire comme ceci:

gardez simplement à l’esprit que cette technique ne crée pas de « vrais” commentaires. Cela insère simplement une constante de texte qui ne fait rien. C’est la même chose que d’insérer une chaîne d’une seule ligne régulière quelque part dans votre code et de ne jamais y accéder.,

cependant, une telle constante de chaîne orpheline n’apparaîtra pas dans le bytecode, le transformant en un commentaire multi-lignes. Voici la preuve que la chaîne inutilisée n’apparaîtra pas dans le désassemblage du bytecode CPython:

cependant, faites attention à l’endroit où vous placez ces « commentaires” dans le code., Si la chaîne suit juste après une signature de fonction, une définition de classe ou au début d’un module, elle se transforme en docstring qui a une signification complètement différente en Python:

Docstrings (« documentation strings”) vous permet d’associer une documentation lisible par l’homme avec des modules, des fonctions, des classes et des méthodes Python. Ils sont différents des commentaires de code source:

un commentaire est supprimé par l’analyseur, alors qu’un docstring se retrouve dans le bytecode et est associé à l’objet documenté. Il est même accessible par programme lors de l’exécution.,

Comme je l’ai dit plus tôt, la seule façon d’obtenir de « vrais” commentaires multi-lignes en Python qui sont ignorés par l’analyseur est d’utiliser plusieurs # commentaires à une ligne.

j’avoue que j’ai été un peu surpris de constater que ce style de commentaire de bloc” faux  » a été approuvé par Guido van Rossum, le créateur de Python: