1
resposta

Para saber mais: comentários

Muito interessante e bem explicado.

Segue minha prática:

Cabeçalho de nível 1

Cabeçalho de nível 2

Cabeçalho de nível 3

Texto em negrito

Texto em itálico

Texto em negrito e itálico

  • Item 1
  • Item 2
  • Item 3
  1. Item 1
  2. Item 2
  3. Item 3

Site da Alura

1 resposta

Olá, Vanelice. Como vai?

Muito bom ver que você está praticando a formatação de textos! Embora o título do tópico mencione comentários, notei que você explorou diversos recursos de marcação de texto, o que é essencial para documentar projetos e organizar células de texto (Markdown) em ambientes como o Jupyter Notebook ou o Google Colab.

Complementando sua prática sobre os comentários especificamente no código Python, existem duas formas principais de utilizá-los para tornar seu trabalho mais compreensível:

  • Comentários de linha única: Utilizamos o símbolo cerquilha # para explicar o que uma linha ou um pequeno bloco de código faz.
  • Docstrings (Comentários de múltiplas linhas): Utilizamos três aspas duplas """ no início e no fim. Elas são muito usadas para documentar o propósito de funções e classes.

Veja um exemplo prático aplicando essas ideias:

# Este é um comentário de linha única: define a variável de bônus
bonus = 500 

"""
Este é um exemplo de Docstring.
Geralmente usamos para explicar o funcionamento de 
um bloco de código mais complexo ou uma função.
"""
def calcular_salario(valor):
    return valor + bonus

Boas práticas ao comentar:

  • Evite o óbvio: Não é necessário comentar algo como x = 10 # define que x vale 10. Use o comentário para explicar o porquê de uma decisão no código, e não apenas o que o código faz.
  • Mantenha atualizado: Se você alterar a lógica do seu código, lembre-se de atualizar o comentário para que ele não confunda outros desenvolvedores (ou você mesmo no futuro).

Dominar tanto a formatação de texto quanto a escrita de bons comentários ajuda muito na colaboração em equipe e na manutenção de projetos de análise de dados.

Espero que possa ter lhe ajudado!