Esta postagem fornece um tutorial rápido sobre como comentar código Python.

Existem três maneiras de comentar o código Python:

• Comentários de linha única
• Comentários de várias linhas
• Comentários de string de documentos

Comentários de linha única

Em Python, comentários de linha única podem ser implementados com o operador #. Isso é demonstrado no exemplo abaixo.

# este comentário pode descrever o que as variáveis ​​abaixo representam
a = 1
b = 3.3

Comentários de várias linhas

Comentários Python de várias linhas podem ser implementados com “”” “””. Mostro isso no exemplo abaixo:

""" DESCRIÇÃO DA FUNÇÃO:
Esta função pega dois parâmetros de entrada, os multiplica e retorna o resultado
entrada: (int) par1, (float) par2
retorna: (float) resultado da multiplicação
"""
def multiplicador(par1,par2):
    return(par1*par2)

Vamos testar rapidamente a função:

multiplicador(a,b)

3.3

Docstring comments

Comentários Docstring são outro tipo de comentários Python. Por convenção, os comentários docstring são usados ​​para documentar funções. Mais precisamente, os comentários docstring são usados ​​para descrever e documentar o que uma função faz – ou seja, qual é o seu efeito, em vez de descrever seus procedimentos internos e tomada de decisão.

Em Python, comentários de docstring também são usados ​​para descrever classes e métodos.

Comentários Docstring devem ser declarados logo após a declaração da função, classe ou método. Eles são implementados com aspas triplas (“”” “””). Aqui está um exemplo:

A função """ retorna o resultado da multiplicação de suas entradas """
    return(par1*par2)

Podemos acessar os comentários docstring de duas maneiras:

• Podemos chamar o método doc do objeto
• Podemos usar a função de ajuda

Aqui está como podemos acessar o comentário docstring chamando o método doc:

multiplicador.__doc__

'função retorna o resultado da multiplicação de suas entradas'

Podemos e.g. imprima este comentário:

print(multiplicador.__doc__)

função retorna o resultado da multiplicação de suas entradas

E aqui está como podemos usar a função help() para acessar os comentários docstring:

ajuda (multiplicador)

Ajuda no multiplicador de funções no módulo __main__:

multiplicador(par1, par2)
    função retorna o resultado da multiplicação de suas entradas

Linnart Felkl

Cientista de dados com foco em simulação, otimização e modelagem em R, SQL, VBA e Python