Como comentar um bloco de código em Python [duplicado]
https://stackoverflow.com/questions/675442
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianPergunta
Esta questão já tem uma resposta aqui:
- Por que não Python tem comentários de várias linhas? 17 respostas
Existe um mecanismo para comentar grandes blocos de código Python?
Agora, as únicas maneiras que eu posso ver de comentar a código são para começar, quer cada linha com um #, ou coloque o código entre aspas triplas:. """
O problema com estes é que a inserção # antes de cada linha é complicado e """ faz a corda que eu quero usar como um comentário aparecer na documentação gerada.
Depois de ler todos os comentários, a resposta parece ser "não".
Solução
Python não tem um tal mecanismo. Preceder um # a cada linha de comentário de bloco. Para mais informações consulte PEP 8 . A maioria das IDEs Python apoiar um mecanismo para fazer as libras-sinais-comentando-com-bloco automaticamente para você. Por exemplo, em IDLE na minha máquina, é Alt + 3 e Alt + 4 .
Não use triplas aspas; como você descobriu, isto é para cordas de documentação não bloquear comentários, embora tenha um efeito similar. Se você está apenas comentando coisas fora temporariamente, isso é bom como uma medida temporária.
Outras dicas
A única cura Eu sei porque este é um bom editor. Desculpe.
Esconder as aspas triplas em um contexto que não será confundido com um docstring, por exemplo:
'''
...statements...
''' and None
ou
if False: '''
...statements...
'''
A única maneira que você pode fazer isso sem aspas triplas é adicionar um:
if False:
E então travessão todo o seu código. Note que o código ainda precisará ter sintaxe apropriada.
Muitos IDEs Python pode adicionar # para você em cada linha selecionada, e removê-los quando un-comentando também. Da mesma forma, se você usar vi ou Emacs você pode criar uma macro para fazer isso para você por um bloco de código.
M-x comment-região, em Emacs modo' Python.
Em JetBrains PyCharm no Mac uso Comando + / para comentário / uncomment bloco selecionado de código. No Windows, use Ctrl + / .
Pelo menos na VIM você pode selecionar a primeira coluna de texto que deseja inserir utilizando o modo Visual Block (CTRL+V em VIMs não Windows) e, em seguida, preceder um # antes de cada linha utilizando esta seqüência:
I#<esc>
No bloco modo Visual I move-se para o modo de inserção com o cursor antes do bloco em sua primeira linha. O texto inserido é copiado antes de cada linha no bloco.
Na vi :
- Ir para o início do bloco e marcá-lo com a letra a.
- Ir para baixo do bloco e marcá-lo com a letra b
Em seguida, faça
:'a,'b s!^!#!
comm='''
Junk, or working code
that I need to comment.
'''
Você pode substituir comm por uma variável de sua escolha que é talvez mais curto, fácil de touch-tipo, e você sabe que não (e não) ocorrem em seus programas. Exemplos:. xxx, oo, null, nil
Sim, há (dependendo do editor). Em PyDev (e em Aptana Studio com PyDev):
-
Ctrl + 4 - comentário do bloco selecionada
-
Ctrl + 5 - bloco seleccionado descomente
No Visual Studio usando os Python Tools para Visual Studio , blocos podem ser comentada por Ctrl + K , Ctrl + C e comentada por Ctrl + K , Ctrl + U .
Eu uso Notepad ++ em uma máquina Windows, selecione o código, tipo CTRL-K. Para descomentar você selecionar o código e pressione Ctrl + Mudança + K .
Aliás, Notepad ++ funciona muito bem como um editor de Python. Com auto-realização, dobramento de código, realce de sintaxe, e muito mais. E é como em discurso livre e como a cerveja!
O único mecanismo para comentar código Python (entendido como código ignorada pelo intérprete) é o # .
Como você disse, você também pode usar strings literais , que não são ignorados pelo interpretador, mas pode ser completamente irrelevante para a execução do programa.
aspas triplas são OK para mim. Você pode usar '' 'foo ''' para docstrings e '' "bar ''" Para comentários ou vice-versa para tornar o código mais legível.
Outra baseada editor solução: texto "retângulos" em Emacs.
Selecione o código que você deseja comentar, em seguida, C-x-r-t #
Para un-comentário do código: destaque, em seguida, C-x-r-k
Eu uso isso todo o dia, todos os dias. (Designado para teclas de atalho, é claro.)
Este e poderoso pesquisa regex / substituição é a razão pela qual eu tolerar outros "excentricidades" do Emacs.
Em Eric4 há uma maneira fácil: selecionar um bloco, digite Ctrl + M para comentar o bloco inteiro ou Ctrl + alt + M para remover o comentário.
Use um editor agradável como SCITE , selecione o seu código, pressione Ctrl + Q e feito.
Se você não tem um editor que suporta bloquear comentários que você pode usar uma string triplo no início e no final do seu bloco de código de comentário 'efetivamente' it out. Não é a melhor prática embora.
