S03 Atividades de Aprendizagem: Comentários no Código
Visão Geral
Comentários escritos por desenvolvedores no código servem para explicar o propósito e o funcionamento de trechos específicos. Como o código pode ser alterado ao longo do tempo, esses comentários funcionam como lembretes, listas de tarefas, anotações de melhorias ou até trechos reutilizáveis (snippets) durante o desenvolvimento. Comentários não são processados nem exibidos ao usuário no documento renderizado em HTML ou CSS, e podem ser inseridos em qualquer espaço em branco disponível no código.
Preparação
Comentários em HTML não são renderizados no navegador. Veja um exemplo de sintaxe de comentário em HTML:
<!-- Este é um comentário em HTML-->Comentários em CSS não afetam o layout nem a apresentação de um documento. Veja um exemplo de sintaxe de comentário em CSS:
/* Este é um comentário */Você pode usar comentários em suas atividades de aprendizagem e tarefas para se lembrar de coisas que deseja consultar ou documentar para uso futuro. Embora esses comentários sejam para seu uso pessoal, tenha em mente que as organizações podem ter requisitos específicos de comentários, já que muitos desenvolvedores podem trabalhar em um projeto ao longo de sua existência.
O conceito de comentários também é usado em suas confirmações (commits) do git, que são especialmente úteis para
rastrear o histórico de revisões e dar contexto às suas confirmações (commits) para a equipe de desenvolvimento.
Criando comentários no VS Code
Para adicionar comentários em HTML, use <!-- no início e --> no final. Em arquivos CSS, utilize
/* no início e */ no final. No VS Code e em muitos outros editores, é possível comentar ou descomentar uma
linha rapidamente com o atalho Ctrl + / (ou Command + / no macOS). Usar o atalho novamente remove o comentário.
O atalho é muito útil para comentar uma seção de código que já existe, basta selecionar o código que você deseja
comentar e pressionar Control + /.
Instruções da Atividade
- Abra qualquer documento HTML ou CSS no VS Code.
- Pressione
ctrl+/ou⌘+/no Mac para comentar a linha atual ou as linhas selecionadas. - Pressionar
ctrl+/ou⌘+/no Mac novamente descomenta as linhas.