Módulo 1 | Aula 1
Introdução à Lógica de Programação
Boas práticas de escrita de algoritmos
Boas práticas de escrita de algoritmos e códigos são fundamentais para garantir qualidade, legibilidade e manutenção a qualquer projeto de software. Seguir padrões de código bem estabelecidos não apenas facilita a colaboração em equipe, mas também melhora a eficiência ao lidar com mudanças e atualizações ao longo do tempo. Quando o código é claro e consistente, outros programadores (ou até o próprio autor, em um momento posterior) conseguem compreendê-lo mais facilmente, reduzindo a chance de erros.
Ignorar essas práticas pode resultar em códigos desorganizados, difíceis de entender e modificar, além de aumentar a probabilidade de erros e bugs. Um código mal estruturado pode gerar mais trabalho para corrigir falhas e para a evolução do projeto. Veja alguns pontos principais em relação a boas práticas:
Variáveis, funções devem ter nomes que revelem sua função ou propósito.
Separe o código em funções ou métodos que realizam tarefas específicas, evitando blocos monolíticos de código.
- Se possível, mantenha as funções pequenas.
- A função deve fazer somente uma tarefa.
Comente o código para explicar partes complexas ou lógicas menos óbvias, sem exageros.
- Comentários longos pode ser um indicativo da complexidade do algoritmo, portanto reveja se é possível simplificar ou dividir o problema.
- Não é fácil, mas mantenha os comentários atualizados, pois um comentário sobre um código que mudou não serve para nada.
- Um comentário pode ir além de apenas informações sobre o código, ele pode informar sobre uma decisão tomada.
- É útil para informar sobre consequências, como o fato de que um código demora 24 horas para ser executado em condições normais.
Use convenções de estilo, como indentação e espaçamento, para garantir que o código seja fácil de ler.
Siga o princípio DRY (Don’t Repeat Yourself), reutilizando o código sempre que possível.
Antecipe e trate possíveis falhas com mecanismos adequados, como exceções e testes.
Defina regras de codificação, principalmente quando trabalhando em equipe.