2.8 KiB
Comente Seu Código
Instruções
Código limpo e bem documentado é essencial para manter e compartilhar seus projetos. Nesta tarefa, você praticará um dos hábitos mais importantes dos desenvolvedores profissionais: escrever comentários claros e úteis que expliquem o propósito e a funcionalidade do seu código.
Revise o arquivo app.js na pasta do seu jogo e encontre maneiras de comentá-lo e organizá-lo. É muito fácil o código sair do controle, e agora é uma boa oportunidade para adicionar comentários e garantir que você tenha um código legível para usar mais tarde.
Sua tarefa inclui:
- Adicionar comentários explicando o que cada seção principal do código faz
- Documentar funções com descrições claras de seu propósito e parâmetros
- Organizar o código em blocos lógicos com cabeçalhos de seção
- Remover qualquer código não utilizado ou redundante
- Usar convenções consistentes de nomenclatura para variáveis e funções
Rubrica
| Critério | Exemplar | Adequado | Precisa Melhorar |
|---|---|---|---|
| Documentação do Código | O código app.js está totalmente comentado com explicações claras e úteis para todas as seções e funções principais |
O código app.js está adequadamente comentado com explicações básicas para a maioria das seções |
O código app.js tem poucos comentários e carece de explicações claras |
| Organização do Código | O código está organizado em blocos lógicos com cabeçalhos de seção claros e estrutura consistente | O código tem alguma organização com agrupamento básico de funcionalidades relacionadas | O código está um pouco desorganizado e difícil de seguir |
| Qualidade do Código | Todas as variáveis e funções usam nomes descritivos, sem código não utilizado, segue convenções consistentes | A maior parte do código segue boas práticas de nomenclatura com pouco código não utilizado | Os nomes das variáveis são pouco claros, contém código não utilizado, estilo inconsistente |
Aviso Legal:
Este documento foi traduzido usando o serviço de tradução por IA Co-op Translator. Embora nos esforcemos pela precisão, esteja ciente de que traduções automatizadas podem conter erros ou imprecisões. O documento original em seu idioma nativo deve ser considerado a fonte autoritativa. Para informações críticas, recomenda-se a tradução profissional humana. Não nos responsabilizamos por quaisquer mal-entendidos ou interpretações incorretas decorrentes do uso desta tradução.