Gerência e Qualidade de Software - Aula 09 - Qualidade de código
Qualidade de Código: O que é um Código Bom?
Introdução à Qualidade do Código
- A aula aborda a importância da qualidade do código e como escrever um código bom, destacando experiências pessoais com códigos complexos e mal documentados.
- O apresentador menciona dificuldades enfrentadas ao lidar com bibliotecas sem documentação adequada, o que dificultava a colaboração em projetos open source.
Características de um Bom Código
- Um código bom deve ser rápido de desenvolver, legível e testável. É importante que ele seja conciso e compreensível para outros desenvolvedores.
- Um bom código é considerado correto (funciona como esperado), eficiente (não desperdiça recursos computacionais) e elegante (simples, limpo e fácil de entender).
Exemplos Práticos
- O apresentador analisa um exemplo de código ruim, onde nomes de variáveis não são descritivos, dificultando a compreensão do que o código faz.
- Em contraste, apresenta uma versão melhorada do mesmo código, onde os nomes das variáveis são claros e o espaçamento está adequado.
Boas Práticas na Nomeação de Variáveis
- Escolher bons nomes para variáveis é fundamental; eles devem revelar claramente seu significado. Nomes genéricos devem ser evitados.
- Seguir convenções da equipe ou linguagem de programação ajuda na clareza dos nomes. Abreviações podem causar confusão se não forem claras.
Estruturação do Código
- Evitar números mágicos no código é essencial; usar constantes torna o propósito dos valores mais claro.
- Os nomes das classes devem ser substantivos no singular representando conceitos. Métodos devem ter nomes verbais que descrevem ações.
Comentários no Código
A Importância da Legibilidade e Qualidade do Código
Comentários no Código
- Comentários não tornam um código ruim mais legível; o ideal é que o código seja autoexplicativo. Comentários devem ser usados apenas para esclarecer intenções ou explicar partes complexas.
- Em vez de comentar códigos obsoletos, recomenda-se apagar esses trechos, utilizando sistemas de controle de versão para manter um histórico.
Programação Defensiva
- A programação defensiva visa prevenir defeitos no software, mesmo que não sejam causados pelo programador. O código deve se proteger contra entradas inadequadas.
- É importante verificar valores dos parâmetros de entrada e dados obtidos de fontes externas, como usuários ou arquivos.
Tratamento de Erros
- Existem várias abordagens para lidar com problemas: lançar exceções, retornar códigos de erro, registrar logs ou apresentar mensagens ao usuário. A escolha depende da situação específica.
Estrutura e Organização do Código
- O espaçamento e a formatação são fundamentais para a qualidade do código. Evitar linhas desnecessárias facilita a leitura; declarar variáveis no início do bloco é uma boa prática.
- Não duplique códigos para facilitar a manutenção; organize o código para reaproveitamento. Cuidado com excessos na otimização, pois isso pode dificultar a compreensão e manutenção do código.
Consistência na Programação