Comentários no Python

1. Como fazer comentários

No Python, como em muitas outras linguagens de programação, dá pra fazer comentários no código.

Comentários são só texto para outros programadores: O interpretador Python simplesmente ignora essa parte, e não executa o código que tá ali. Eles ajudam programadores e outros membros do projeto a entenderem o código, o que é super útil em trabalhos colaborativos ou manutenção ao longo do tempo. No Python, tem algumas maneiras de adicionar comentários no código.

Comentários de uma linha:

Esses começam com o símbolo #. Tudo que vem depois de um # na mesma linha é ignorado pelo interpretador Python. Esse tipo é usado pra notas rápidas ou explicações pra linhas específicas no código. Exemplo:

# Isso é um comentário de uma linha
print("Hello, World!")  # Explicação da função

Comentários de múltiplas linhas:

Oficialmente, Python não tem uma sintaxe específica pra comentários de múltiplas linhas, mas dá pra fazer usando vários comentários de uma linha ou literais de strings de múltiplas linhas (mas isso, na real, é só um literal de string que não é executado como código). Exemplo:

# Isso é um exemplo de comentário de múltiplas linhas
# Cada linha começa com o símbolo `#`

ou:

""" Isso é um literal de string de múltiplas linhas, que pode ser usado como comentário. O Python entende isso como uma string, mas não faz nada com ela se não for atribuída a uma variável ou usada em uma expressão. """

Fica a dica! Literal é aquele pedaço de dado direto no código: número, string, e por aí vai.

2. Por que escrever comentários

Colocar comentários no código melhora a legibilidade, facilita manutenção e atualização, e ainda ajuda a galera a trabalhar junto de forma mais tranquila. Comentários devem ser curtos, mas informativos e relevantes, servindo como documentação útil sem encher o código de informação desnecessária.

Docstrings (documentação em strings):

Essas são strings de múltiplas linhas, geralmente colocadas no começo de módulos, classes, métodos e funções pra explicar a função deles. Elas são envoltas por três pares de aspas duplas e podem ser usadas pra gerar documentação automática.

Exemplo:

def add(a, b): """ Função para somar dois números. :param a: primeiro número :param b: segundo número :return: soma de a e b """ return a + b 

No mundo da programação, de vez em quando a galera bota uns comentários no código que, além de explicar, ainda arrancam uma risada. Aqui vão alguns exemplos de comentários engraçados que você pode encontrar:

Exemplo 1:

# Eu explicaria o que acontece aqui, mas nem eu entendo mais.

Exemplo 2:

# Se isso não funcionar, a culpa é de outra pessoa.

Exemplo 3:

# Veni, vidi, corrigi... e quebrei.

Exemplo 4:

# Quando escrevi isso, só eu e Deus sabíamos como funciona.
# Agora só Deus sabe.

Exemplo 5:

# Horas desperdiçadas aqui = 42.

Esses comentários podem deixar o trabalho mais leve e engraçado, e ainda lembram que programar é um processo criativo e bem humano.

5.3 Comentar código rapidinho

No PyCharm IDE dá pra comentar ou descomentar código rapidinho usando atalhos. É só selecionar as linhas que você quer comentar ou descomentar e apertar Ctrl + / no Windows (ou Cmd + / no macOS). Esse atalho coloca ou tira o símbolo de comentário em cada linha selecionada, facilitando muito o processo.