Importante

Você está vendo a versão anterior da nova experiência da Alura que estamos preparando para você. Em breve, ela ganha uma identidade visual novinha totalmente pensada em potencializar seus estudos!

2
respostas

Para saber mais: comentários - Pratica e dúvida sobre uso do cabeçalho

Olá pessoal,

Testei no Google Colab e deu certo. Fiz apenas para praticar.

Insira aqui a descrição dessa imagem para ajudar na acessibilidade
Sobre a construção dos cabeçalhos seria apenas para adicionar fora da célula de execução dos códigos afim de deixar descrições, informações, instruções, etc? Ou essas configurações de textos em Negrito, Itálico, em bullets, etc, podem ser também ser adicionadas nos comentários dentro da célula?

Insira aqui a descrição dessa imagem para ajudar na acessibilidade

2 respostas

Olá, Vanessa. Como vai?

Excelente pergunta! É muito comum surgir essa dúvida ao começar a utilizar o Google Colab ou o Jupyter Notebook.

A resposta curta é: as configurações de formatação (negrito, itálico, cabeçalhos, listas) funcionam apenas em células de texto, que utilizam uma linguagem chamada Markdown. Nas células de código, os comentários são textos puros ignorados pelo Python e não possuem suporte nativo para essa estilização visual.

Aqui estão os pontos principais para diferenciar o uso:

  • Células de Texto (Markdown): São usadas para a documentação narrativa do projeto. Como você testou, nelas você pode criar uma hierarquia com cabeçalhos (#), destacar termos importantes com negrito e organizar passos com listas. Isso torna o notebook um relatório profissional e legível.
  • Células de Código (Comentários): O símbolo # dentro de uma célula de código serve apenas para indicar ao Python que aquela linha não deve ser executada. Se você tentar usar negrito ali, o Python apenas exibirá os asteriscos como texto comum, sem aplicar a formatação. Eles servem para explicações técnicas rápidas e pontuais sobre o que um trecho específico do código faz.

Para manter seus projetos organizados, uma boa prática é:

  • Use células de texto para explicar o "porquê" de uma análise e os resultados obtidos.
  • Use comentários no código para explicar o "como" aquele script funciona tecnicamente.
# Exemplo de comentário técnico (sem formatação visual)
valor = 10 # Define a variável base

Continue explorando essas ferramentas, pois uma boa documentação é um diferencial enorme na área de Data Science!

Espero que possa ter lhe ajudado!

Olá Evandro,

Entendi sim, muito obrigada pela explicação clara.

Anotado!