2.7 KiB
Comente o Seu Código
Instruções
Código limpo e bem documentado é essencial para manter e partilhar os seus projetos. Nesta tarefa, irá praticar um dos hábitos mais importantes dos programadores profissionais: escrever comentários claros e úteis que expliquem o propósito e a funcionalidade do seu código.
Revise o seu ficheiro app.js atual na pasta do seu jogo, e encontre formas de o comentar e organizar. É muito fácil o código fugir do controlo, e agora é uma boa oportunidade para adicionar comentários para garantir que tem um código legível para poder utilizá-lo mais tarde.
A sua tarefa inclui:
- Adicionar comentários que expliquem o que cada secção principal do código faz
- Documentar funções com descrições claras do seu propósito e parâmetros
- Organizar o código em blocos lógicos com cabeçalhos de secção
- Remover qualquer código não utilizado ou redundante
- Usar convenções de nomes consistentes para variáveis e funções
Rubrica
| Critério | Exemplar | Adequado | Precisa de Melhorar |
|---|---|---|---|
| Documentação do Código | Código app.js totalmente comentado com explicações claras e úteis para todas as secções e funções principais |
Código app.js adequadamente comentado com explicações básicas para a maioria das secções |
Código app.js tem comentários mínimos e carece de explicações claras |
| Organização do Código | Código organizado em blocos lógicos com cabeçalhos de secção claros e estrutura consistente | Código tem alguma organização com agrupamento básico de funcionalidades relacionadas | 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, não há código não utilizado, segue convenções consistentes | A maioria do código segue boas práticas de nomes com código não utilizado mínimo | Nomes de variáveis pouco claros, contém código não utilizado, estilo inconsistente |
Aviso Legal: Este documento foi traduzido utilizando o serviço de tradução automática Co-op Translator. Embora nos esforcemos pela precisão, por favor note que as traduções automáticas podem conter erros ou imprecisões. O documento original na sua língua nativa deve ser considerado a fonte autorizada. Para informações críticas, recomenda-se tradução profissional humana. Não nos responsabilizamos por quaisquer mal-entendidos ou interpretações erradas decorrentes do uso desta tradução.