Introdução aos comentários e à legibilidade do código

Comentários são usados para explicar o código e torná-lo mais legível. Eles são ignorados pelo interpretador do Python e não afetam a execução do programa.

Nesta lição, você aprenderá a usar comentários e a escrever um código limpo e legível.

Comentários de uma linha

Os comentários de uma linha começam com um #. Tudo o que vem depois do # nessa linha é ignorado pelo Python. Por exemplo:

# This is a single-line comment
print("Hello, World!")

Comentários de várias linhas

Os comentários de várias linhas podem ser escritos usando aspas triplas (''' ou """). Por exemplo:

"""
This is a multi-line comment.
It spans multiple lines.
"""
print("Hello, World!")

Por que usar comentários?

Os comentários ajudam a:

• Explicar códigos complexos.
• Tornar o código mais fácil de entender para outras pessoas e para você no futuro.
• Depurar e solucionar problemas.

Lembre-se: os comentários são para as pessoas, não para a máquina!

Boas práticas para escrever comentários

Veja algumas dicas para escrever bons comentários:

• Mantenha os comentários concisos e significativos.
• Evite comentários óbvios, como # Increment x by 1 para x = x + 1.
• Use comentários para explicar por que o código foi escrito de determinada maneira.

Melhorando a legibilidade do código

Um código legível é mais fácil de manter e depurar. Veja algumas dicas:

• Use nomes significativos para variáveis e funções.
• Mantenha as linhas de código curtas.
• Organize o código em seções usando comentários.

Comentando o código

Você pode usar comentários para desativar temporariamente um código durante a depuração. Por exemplo:

# print("This line is commented out and won’t run.")
print("This line will run.")

Exemplo: documentando uma função

Você pode usar comentários para documentar funções e explicar a finalidade delas:

def greet(name):
    # This function greets the user by their name.
    print("Hello,", name)

greet("Alice")

O que aprendemos?

Nesta lição, você aprendeu:

• Como escrever comentários de uma linha e de várias linhas em Python.
• A importância dos comentários para a legibilidade e a manutenção do código.
• Boas práticas para escrever comentários e melhorar a legibilidade do código.

Parabéns! Vamos passar ao próximo tópico.