Python Tutorial - Declaração e Comentário

  1. Declaração Python
  2. Indentação Python
  3. Comentários em Python

Nesta seção, serão discutidas declarações Python, indentação e comentários. Docstring’ como um tipo especial de comentário Python também é introduzido na última sessão.

Declaração Python

Uma declaração Python é uma instrução dada ao intérprete para executar. Uma declaração pode conter uma expressão como abaixo

result = x + y

A declaração Python pode ser considerada como uma instrução ao intérprete para resolver a expressão e armazenar seu resultado em uma variável. As afirmações como for, while, print têm um significado especial; estas afirmações serão discutidas em uma seção posterior.

Declarações Python com várias linhas

Quando você pressiona a tecla enter após uma declaração, essa declaração específica é encerrada e é uma declaração de uma linha. Um comando de várias linhas pode ser criado em Python utilizando o caractere de continuação de linha \ que estenderá o comando Python para várias linhas.

Considere o código abaixo:

x = 100 + 101 + 102 \
    + 103 + 104 \
    + 105

Isto é chamado de continuação de linha explícita.

Você também pode fazer a continuação de linha implícita utilizando parênteses (), colchetes [] ou chaves {}.

Por exemplo, você pode escrever acima da expressão de múltiplas linhas utilizando parênteses como:

x = (100 + 101 + 102 
    + 103 + 104 
    + 105)

Indentação Python

O bloco de instruções, por exemplo, o corpo de uma função ou um loop ou classe, começa com recuo. O recuo deve ser o mesmo para cada expressão dentro do bloco. Você receberá um IndentationError quando o recuo estiver incorreto.

Normalmente, 4 espaços para indentação como aconselhado em Guia de Estilo para Código Python. Considere o exemplo abaixo:

x = {1, 2, 3, 4}
for i in x:
    print(i)

A indentação é basicamente usada para criar programas mais legíveis.

No exemplo abaixo, o mesmo código é escrito de duas maneiras diferentes:

x = {1, 2, 3, 4}
for i in x:
    print(i)

for i in x: print(i)

Você pode ver aqui que o primeiro exemplo tem uma legibilidade melhor do que o segundo.

Comentários em Python

Os comentários são usados para descrever o propósito ou o funcionamento de um programa. Os comentários são as linhas ignoradas por Python durante a interpretação e não perturbam o fluxo de um programa.

Se você estiver escrevendo um código de centenas de linhas, você deve adicionar comentários, pois outro usuário não tem tempo suficiente para ler cada linha para entender o funcionamento do código. Desta forma, os comentários aumentam a legibilidade e explicam como o código funciona também.

Um comentário Python começa a partir do símbolo hash #.

#Single Line comment
#Program to print a string
print("Hello Python Programmer")

Comentários em Python Multi-Linhas

Usando o símbolo hash em cada linha pode definir um comentário com várias linhas. Mas há outra maneira de adicionar um comentário multi-linha em Python, que é usando aspas triplas. Você pode utilizar ''' ou """.

"""Multi-line
comments in 
Python Programming language"""

As aspas triplas são realmente utilizadas para definir uma string de documentação com várias linhas, mas você também pode utilizá-las como comentários com várias linhas.

Docstring em Python

Docstring é a string de documentação que é a primeira declaração em uma função, classe, módulo, etc. Python. A descrição e comentários de funções, métodos e classe estão dentro de uma docstring (string de documentação).

Considere o exemplo abaixo:

def sum(a, b):
    """This function adds two values"""
    return a+b

Você pode ver aqui a docstring diz o que a função faz.