Este projeto é uma refatoração do projeto original, com melhoras na legibilidade e qualidade de código.
Focando nas boas práticas da linguagem/programação e na filosofia de código limpo.
- Nomes de métodos, funções e variáveis em inglês
- Retirada de números mágicos
- Variáveis com nomes objetivos e precisos
- Não limitar nome da variável
- Nomes de métodos e funções devem ser verbos
- Nomes de variáveis devem ser substantivos
- Comentário desde que não seja explicando o código
- Não duplicidade de código
- Utilizar try-catch e exceptions
- Funções e métodos coesos
- Evitar condicional negativa (ex: "!fazer" e sim "fazer")
- Código legível (ex: if(student.isActive()) ao invés de if(student.status === 'active'))
- Evitar o uso de flags como parâmetro
- Documentar métodos e funções com javadoc
- Refatorar testes existentes e criar novos
