Option 2: Using Multi-line Strings as Comments

Another option for writing “proper” multi-line comments in Python is to use multi-line strings with the """ syntax in creative ways. Aqui está um exemplo:

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

Como você pode ver, você pode usar strings de citação tripla para criar algo que se assemelha a um comentário multi-linha em Python., Você só precisa se certificar de indentar o primeiro""" corretamente, caso contrário você vai ter umSyntaxError. Por exemplo, se você gostaria de definir um comentário em bloco dentro de uma função com esta técnica, você tem que fazê-lo assim:

apenas tenha em mente que esta técnica não cria comentários “verdadeiros”. Isto simplesmente insere uma constante de texto que não faz nada. É o mesmo que inserir uma linha única normal em algum lugar do seu código e nunca acessá-lo.,

no entanto, uma constante de string órfã não aparecerá no bytecode, transformando-o efetivamente em um comentário multi-linha. Aqui está a prova de que o texto não usado não irá aparecer na desmontagem do bytecode CPython:

no entanto, tenha cuidado onde você coloca estes “comentários” no código., Se o texto segue logo após uma assinatura de função, uma definição de classe, ou no início de um módulo, ele se transforma em uma docstring que tem um significado diferente completamente em Python:

Docstrings (“cadeias de documentação”) permite associar documentação legível pelo homem com módulos, funções, classes e métodos Python. Eles são diferentes dos comentários do código fonte:

um comentário é removido pelo analisador, enquanto uma docstring termina no bytecode e é associado com o objeto documentado. Ele pode até ser acessado programaticamente em tempo de execução.,

Como eu disse anteriormente, a única maneira de obter comentários “true” multi-line em Python que são ignorados pelo analisador é usar múltiplos# comentários de linha única.

admito que fiquei um pouco surpreso ao descobrir que este estilo de comentário em bloco “falso”foi endossado por Guido van Rossum, o criador de Python: