Python/Conceitos básicos/Comentários e docstrings

De Wikibooks

Voltar para a página inicial.

---

Há em todas as linguagens de programação a necessidade de documentar uma linha ou um bloco de código para documentar o que serve aquele bloco de código. Em Python comentários são iniciados com #, tudo que estiver depois do # será ignorado pelo interpretador, portanto considerado como comentários, o fechamento do comentário acaba quando acabar a linha do interpretador. As docstrings são mais comumente introduzidas no início de uma classe ou no início do programa para definir o escopo do software ou o escopo de métodos, seu símbolo padrão são as três aspas duplas ou simples. A diferença visível entre comentários e docstrings é o que cabe dentro delas, por exemplo:

• Comentários:

def valor1(self):
    try:
       self.c = input('Primeiro valor: ')
       c = self.c
       return c
    except: # lança a exceção
       print ' Inválido! '
       self.valor1()

• Docstrings:

def valor1(self):
    '''
    Entrada do primeiro valor do cálculo.
    Por exemplo:
    >>> Primeiro Valor: 2
    '''

    try:
       self.c = input('Primeiro valor: ')
       c = self.c
       return c
    except:
       print ' Inválido! '
       self.valor1()