Padrões de Clean Code

Histórico de Revisão

Data	Versão	Descrição	Autor
10/05/2023	1.0	Construção do arquivo	Ana Catarina

Padrões de Clean Code

No desenvolvimento do código em questão, foram aplicados diversos padrões de clean code para garantir a qualidade e a legibilidade do mesmo. Seguem abaixo alguns exemplos desses padrões adotados:

• Utilização do idioma inglês: Todo o código foi escrito em inglês, seguindo as práticas amplamente adotadas pela comunidade de desenvolvedores. Isso facilita a compreensão e colaboração entre membros da equipe, mesmo que tenham diferentes origens linguísticas.

• Nomes significativos: As variáveis, funções, classes e módulos foram nomeados de forma clara e descritiva. Os nomes escolhidos refletem com precisão o propósito e a funcionalidade de cada elemento do código, tornando mais fácil entender sua finalidade e utilizar corretamente.

• Estruturação e formatação clara: O código foi organizado de forma lógica e bem estruturada. Foram utilizadas indentação adequada, espaçamento consistente e formatação coerente em todo o código. Isso contribui para a legibilidade e compreensão rápida do código, evitando confusões e facilitando a manutenção futura.

• Uso do camelCase: Conforme as convenções amplamente adotadas, as variáveis e funções foram nomeadas utilizando o padrão camelCase. Isso melhora a clareza dos nomes, facilitando a distinção entre palavras e garantindo consistência visual no código.

• Responsabilidade única: Cada função, classe ou módulo possui uma única responsabilidade bem definida. Essa abordagem facilita a compreensão e a manutenção do código, tornando-o mais modular, reutilizável e menos propenso a erros.

Esses padrões de clean code foram aplicados com o intuito de promover um código de qualidade, legível e de fácil manutenção. Ao seguir essas boas práticas, garantimos um código mais eficiente, colaborativo e de alta qualidade.

Referências

• Material do moodle da disciplina