Existe uma maneira de criar comentários multilinhas no Python?

Recentemente, comecei a estudar Python , mas não consegui descobrir como implementar comentários de várias linhas. A maioria dos idiomas possui símbolos de comentário de bloco como

/*

*/

Eu tentei isso em Python, mas ele gera um erro, então essa provavelmente não é a maneira correta. O Python realmente possui um recurso de comentário multilinha?

Você pode usar cadeias de caracteres triplas. Quando não são uma sequência de documentos (a primeira coisa em uma classe / função / módulo), eles são ignorados.

'''
This is a multiline
comment.
'''

(Certifique-se de recuar a liderança '''adequadamente para evitar um IndentationError.)

Guido van Rossum (criador do Python) twittou isso como uma "dica profissional".

No entanto, o guia de estilo do Python, PEP8, prefere o uso de comentários consecutivos de linha única , e é também isso que você encontrará em muitos projetos. Os editores de texto geralmente têm um atalho para fazer isso facilmente.

O Python possui uma sintaxe de cadeia de caracteres / comentário multilinha no sentido de que, a menos que seja usada como documentação, as cadeias de# linhas múltiplas não geram bytecode - assim como comentários pré-definidos. Com efeito, ele age exatamente como um comentário.

Por outro lado, se você disser que esse comportamento deve ser documentado na documentação oficial para ser uma verdadeira sintaxe de comentário, sim, você diria que não é garantido como parte da especificação do idioma.

De qualquer forma, seu editor de texto também poderá comentar facilmente uma região selecionada (colocando um #na frente de cada linha individualmente). Caso contrário, mude para um editor de texto que sim.

Programar em Python sem certos recursos de edição de texto pode ser uma experiência dolorosa. Encontrar o editor certo (e saber usá-lo) pode fazer uma grande diferença na percepção da experiência de programação do Python.

O editor de texto não deve apenas comentar as regiões selecionadas, mas também pode deslocar facilmente os blocos de código para a esquerda e a direita, além de posicionar automaticamente o cursor no nível de recuo atual ao pressionar Enter. A dobragem de código também pode ser útil.

Para se proteger contra a deterioração de links, eis o conteúdo do tweet de Guido van Rossum :

Dica do @BSUCSClub Python: você pode usar sequências de várias linhas como comentários de várias linhas. A menos que usado como docstrings, eles não geram código! :-)

A partir da resposta aceita ...

Você pode usar cadeias de caracteres triplas. Quando não são uma sequência de documentos (a primeira coisa em uma classe / função / módulo), eles são ignorados.

Isto simplesmente não é verdade. Diferentemente dos comentários, as cadeias de caracteres triplas ainda são analisadas e devem ser sintaticamente válidas, independentemente de onde elas apareçam no código-fonte.

Se você tentar executar esse código ...

def parse_token(token):
    """
    This function parses a token.
    TODO: write a decent docstring :-)
    """

    if token == '\\and':
        do_something()

    elif token == '\\or':
        do_something_else()

    elif token == '\\xor':
        '''
        Note that we still need to provide support for the deprecated
        token \xor. Hopefully we can drop support in libfoo 2.0.
        '''
        do_a_different_thing()

    else:
        raise ValueError

Você receberá ...

ValueError: invalid \x escape

... no Python 2.x ou ...

SyntaxError: (unicode error) 'unicodeescape' codec can't decode bytes in position 79-80: truncated \xXX escape

... no Python 3.x.

A única maneira de fazer comentários de várias linhas que são ignorados pelo analisador é ...

elif token == '\\xor':
    # Note that we still need to provide support for the deprecated
    # token \xor. Hopefully we can drop support in libfoo 2.0.
    do_a_different_thing()

No Python 2.7, o comentário multilinha é:

"""
This is a
multilline comment
"""

Caso esteja dentro de uma classe, você deve tabular adequadamente.

Por exemplo:

class weather2():
   """
   def getStatus_code(self, url):
       world.url = url
       result = requests.get(url)
       return result.status_code
   """

AFAIK, Python não tem comentários de bloqueio. Para comentar linhas individuais, você pode usar o #caractere.

Se você estiver usando o Notepad ++ , há um atalho para comentários em bloco . Tenho certeza que outros como gVim e Emacs têm recursos semelhantes.

Eu acho que não, exceto que uma cadeia de linhas múltiplas não é processada. No entanto, a maioria, se não todos os IDEs do Python, têm uma tecla de atalho para 'comentar' várias linhas de código.

Se você colocar um comentário em

"""
long comment here
"""

no meio de um script, Python / linters não reconhecerá isso. A dobragem será confusa, pois o comentário acima não faz parte das recomendações padrão. É melhor usar

# Long comment
# here.

Se você usa o Vim , pode plugins como commentary.vim , para comentar automaticamente longas filas de comentários pressionando Vjgcc. Onde Vjseleciona duas linhas de código e as gcccomenta.

Se você não quiser usar plug-ins como o descrito acima, use a pesquisa e substitua-o como

:.,.+1s/^/# /g

Isso substituirá o primeiro caractere na linha atual e na próxima com #.

Não existe um recurso como um comentário de várias linhas. #é a única maneira de comentar uma única linha de código. Muitos de vocês responderam '' 'um comentário' '' como sua solução.

Parece funcionar, mas internamente '''no Python utiliza as linhas delimitadas como seqüências regulares que o intérprete não ignora como o uso de comentários #.

Consulte a documentação oficial aqui

Infelizmente, a stringificação nem sempre pode ser usada como comentário! Portanto, é mais seguro seguir o padrão que antecede cada linha com a #.

Aqui está um exemplo:

test1 = [1, 2, 3, 4,]       # test1 contains 4 integers

test2 = [1, 2, '''3, 4,'''] # test2 contains 2 integers **and the string** '3, 4,'

Bem, você pode tentar isso (ao executar o citado, a entrada para a primeira pergunta deve ser citada '):

"""
print("What's your name? ")
myName = input()
print("It's nice to meet you " + myName)
print("Number of characters is ")
print(len(myName))
age = input("What's your age? ")
print("You will be " + str(int(age)+1) + " next year.")

"""
a = input()
print(a)
print(a*5)

O que for incluído entre """será comentado.

Se você está procurando comentários de linha única, é isso #.

Comentário multilinha em Python:

Para mim, '' 'e "" "funcionaram.

Exemplo:

a = 10
b = 20
c = a+b
'''
print ('hello')
'''
print ('Addition is: ', a+b)

Exemplo:

a = 10
b = 20
c = a+b
"""
print('hello')
"""
print('Addition is: ', a+b)

Os comentários embutidos no Python começam com um caractere de hash.

hello = "Hello!" # This is an inline comment
print(hello)

Olá!

Observe que um caractere de hash em um literal de seqüência de caracteres é apenas um caractere de hash.

dial = "Dial #100 to make an emergency call."
print(dial)

Disque # 100 para fazer uma chamada de emergência.

Um caractere de hash também pode ser usado para comentários de uma ou várias linhas.

hello = "Hello"
world = "World"
# First print hello
# And print world
print(hello)
print(world)

Olá

Mundo

Coloque o texto entre aspas duplas triplas para oferecer suporte a doutrinas.

def say_hello(name):
    """
    This is docstring comment and
    it's support multi line.
    :param name it's your name
    :type name str
    """
    return "Hello " + name + '!'


print(say_hello("John"))

Olá john!

Coloque o texto entre aspas simples triplas para comentários em bloco.

'''
I don't care the parameters and
docstrings here.
'''

No Python 2.7.13:

Solteiro:

"A sample single line comment "

Multilinha:

"""
A sample
multiline comment
on PyCharm
"""

Alternar comentário oficial de várias linhas universal do Visual Studio Code .

macOS: selecione o bloco de código e, em seguida, ⌘+/

Windows: selecione o bloco de código e, em seguida, Ctrl+/

Sim, é bom usar os dois:

'''
Comments
'''

e

"""
Comments
"""

Porém, a única coisa que você precisa se lembrar enquanto executa um IDE é que 'EXECUTAR' o arquivo inteiro para ser aceito como vários códigos de linhas. Linha por linha 'RUN' não funcionará corretamente e mostrará um erro.

Para comentar várias linhas de código no Python, basta usar um #comentário de linha única em todas as linhas:

# This is comment 1
# This is comment 2 
# This is comment 3

Para escrever comentários "apropriados" de várias linhas no Python, é usar strings de várias linhas com a """sintaxe Python que possui o recurso de strings de documentação (ou docstrings). Ele fornece aos programadores uma maneira fácil de adicionar notas rápidas com todos os módulos, funções, classes e métodos do Python.

'''
This is
multiline
comment
'''

Além disso, mencione que você pode acessar a documentação por um objeto de classe como este

myobj.__doc__

Você pode usar o seguinte. Isso é chamado DockString.

def my_function(arg1):
    """
    Summary line.
    Extended description of function.
    Parameters:
    arg1 (int): Description of arg1
    Returns:
    int: Description of return value
    """
    return arg1

print my_function.__doc__

Eu desaconselho o uso """de comentários em várias linhas!

Aqui está um exemplo simples para destacar o que pode ser considerado um comportamento inesperado:

print('{}\n{}'.format(
    'I am a string',
    """
    Some people consider me a
    multi-line comment, but
    """
    'clearly I am also a string'
    )
)

Agora dê uma olhada na saída:

I am a string

    Some people consider me a
    multi-line comment, but
    clearly I am also a string

A sequência de várias linhas não foi tratada como comentário, mas foi concatenada 'clearly I'm also a string'para formar uma única sequência.

Se você quiser comentar várias linhas, faça-o de acordo com as diretrizes do PEP 8 :

print('{}\n{}'.format(
    'I am a string',
    # Some people consider me a
    # multi-line comment, but
    'clearly I am also a string'
    )
)

Resultado:

I am a string
clearly I am also a string

Usando o PyCharm IDE.

Você pode commente uncommentlinhas de código usando Ctrl + /. Ctrl + / comenta ou descomenta a linha atual ou várias linhas selecionadas com comentários de linha única ({# in Django templates, or # in Python scripts). Pressing Ctrl+Shift+/para um bloco selecionado de código-fonte em um modelo do Django envolve o bloco com {% comment %} and {% endcomment %}tags.

---

n = 5
while n > 0:
    n -= 1
    if n == 2:
        break
    print(n)

print("Loop ended.")

Selecione todas as linhas e pressione Ctrl + /

# n = 5
# while n > 0:
#     n -= 1
#     if n == 2:
#         break
#     print(n)

# print("Loop ended.")

Um comentário multilinha não existe realmente no Python. O exemplo abaixo consiste em uma sequência não atribuída, validada pelo Python para erros sintáticos.

Alguns editores de texto, como o Notepad ++ , fornecem atalhos para comentar um trecho de código ou palavras.

def foo():
    "This is a doc string."
    # A single line comment
    """
       This
       is a multiline
       comment/String
    """
    """
    print "This is a sample foo function"
    print "This function has no arguments"
    """
    return True

Além disso, Ctrl+ Ké um atalho no Bloco de notas ++ para bloquear comentários. Ele adiciona um #na frente de cada linha da seleção. Ctrl+ Shift+ Ké para descomentar bloco.

Entre outras respostas, acho que a maneira mais fácil é usar as funções de comentários do IDE que usam o suporte a comentários do Python #.

Estou usando o Anaconda Spyder e ele tem:

• Ctrl+ 1- Comentário / comentário
• Ctrl+ 4- Comente um bloco de código
• Ctrl+ 5- Descomente um bloco de código

Comentaria / descomentaria uma / várias linhas / s de código com #.

Eu acho o mais fácil.

Por exemplo, um comentário em bloco:

# =============================================================================
#     Sample Commented code in spyder
#  Hello, World!
# =============================================================================

Selecione as linhas que deseja comentar e, em seguida, use Ctrl+ ?para comentar ou descomentar o código Python no editor Sublime Text .

Para linha única, você pode usar Shift+ #.