Como comentar um bloco de código em Python

Existe algum mecanismo para comentar grandes blocos de código Python?

Neste momento, as únicas formas que vejo de comentar o código são iniciar cada linha com um #, ou anexar o código entre aspas triplas: """".

O problema com isso é que inserir # antes de cada linha é incômodo e """" faz com que a string que eu quero utilizar como comentário apareça na documentação gerada.

Depois de ler todos os comentários, a resposta parece ser "No".

Solução

Python não tem tal mecanismo. Prefira um `#' a cada linha para bloquear comentários. Para mais informações, veja PEP 8. A maioria dos IDEs Python suportam um mecanismo para fazer o comentário de bloco com sinais de libra automaticamente para você. Por exemplo, no IDLE na minha máquina, it's Alt+3 e Alt+4.

Don't use aspas triplas; como você descobriu, isto é para cordas de documentação que não bloqueiam comentários, embora tenha um efeito semelhante. Se você'estiver apenas comentando coisas temporariamente, isto é bom como uma medida temporária.

Comentários (30)

A única cura que eu conheço para isto é um bom editor. Desculpe.

Comentários (2)

A única forma de o fazer sem aspas triplas é adicionando uma:

if False:

E depois indentar todo o seu código. Note que o código ainda precisa de ter a sintaxe adequada.


Muitos IDEs Python podem adicionar `#' para você em cada linha selecionada, e removê-los quando não forem comentados também. Da mesma forma, se você usar vi ou Emacs você pode criar uma macro para fazer isso para você para um bloco de código.

Comentários (5)