O documento aborda a qualidade de código, enfatizando a importância de uma boa prática de codificação para facilitar a colaboração e manutenção. Inclui tópicos como pré-requisitos de codificação, técnicas de estruturação, melhores práticas de nomenclatura, reutilização de código e documentação. Além disso, destaca a relevância da programação defensiva para controle de erros e a necessidade de equilibrar legibilidade e otimização do código.

1. Qualidade de Código
Victor Henrique Queiroga de oliveira

2. TÓPICOS
 MOTIVAÇÃO
 PRÉ-REQUISITOS DE CODIFICAÇÃO
 ESTILOS DE CODIFIÇÃO
 MELHORANDO A ESCRITA
 IDENTIFICADORES
 PADRÕES DE NOMENCLATURA
 TÉCNICAS DE ESTRUTURAÇÃO DE CÓDIGO
 FERRAMENTAS
 DOCUMENTAÇÃO

3. TÓPICOS
 REAPROVEITAMENTO DE CÓDIGO
 BIBLIOTECAS
 PROGRAMAÇÃO DEFENSIVA

4. Motivações
 Frequentemente, encontrar uma solução a um problema é um feito
individual;
 Muitas vezes programadores que trabalham em equipe devem
contribuir entre si;
 Escrever corretamente o código auxilia na busca dos objetivos;
 Programar sempre foi importante;

5. Motivações
Com isso, outras atividades permanecem em pauta:
 Tradução de especificação de código;
 Análise de código de outros programadores;
 Modificar código para remover defeitos.

6. Pré-requisitos da codificação
Instrumentos necessários

7. Conhecimento da sintaxe e semântica
 As linguagens atuais possuem um repertório extenso de sintaxe e
semântica;
 Seu desconhecimento torna facilmente um programa mais
complicado do que realmente é;
 E portanto, pode significar que desenvolvedores estejam fazendo
esforço desnecessário;
Obs.: Cuidado para não reinventar a roda!!!

8. Dica 1:
Conheça bem a API

9. Conhecimento e uso de técnicas
 Escrita e organização de textos;
 Inclusão das informações necessárias a futuras atividades de
manutenção e testes;
 Inclusão no código de dispositivos de segurança;

10. Leitura de código
Compreensão e melhora da escrita

11. Compreensão da semântica
 As linguagens de programação não foram projetadas para tornar fácil
a leitura;
 Cada diferente linguagem de programação acaba possuindo um estilo
de escrita;
 Regras simples de estilo de codificação podem poupar trabalho de
compreensão;

12. Melhorando a escrita
Garantir uma leitura mais fácil do programa é um objetivo
recompensado com diversas vantagens:
 Menor probabilidade de perda de controle sobre a complexidade;
 Maior facilidade de depurar;
 Melhora o trabalho em equipe.

13. Exemplos de regras e dicas de estilo
Descrição Solução
Confusão entre o operador de atribuição = e o
operador de comparação ==
Acostumar-se a sempre usar:
if(5 == a) em lugar de if(a == 5)
Uso combinado de atribuição e comparação com nulo Usar if(null != (a=b)) em lugar de if(a = b)
Falta de comandos break em um switch Utilizar o recurso de auto completar, disponível na
maioria do editores de código
Erro de aninhamento de comandos if / else Escrever código usando adequadamente as chaves {}
Leitura complexa causada pela “sopa de letras” (Falta
de identação, nomenclatura confusa, etc.)
Usar corretamente as técnicas de recuos,
espaçamento e alinhamento

14. Identificadores
Alguns programadores se confundem no momento de escolher
identificadores, o que gera dificuldade na compreensão.
 É impossível a outro programador deduzir o propósito de cada
variável;
 O próprio programador que escolheu os nomes pode ter dificuldade
depois de um tempo;
 A atividade de resolução de erros torna-se mais difícil;

15. Identificadores
 Os identificadores podem levar à direção da auto documentação de
código;
 Existem várias estilos de nomenclatura com abordagens diferentes;
 Não existem normas universalmente aceitas;

16. Tipos de nomenclatura
1. Indicação de Tipos associados;
2. Indicação da Função;

17. Identificadores (Tipo associado)
ELEMENTO PREFIXO
Formulário frm
Texto txt
TextArea txa
CheckBox chk
Hidden hdn
Password psw
Botão Radio rdo
Botão Reset rst
Botão Submit sbt
Select slt
Um padrão de nomenclatura em HTML
Exemplo:
<input type=“text” id=“txtLogin” value=“” />

18. Identificadores (Função associada)
Prefixo SIGNIFICADO
min Valor mínimo de algo
max Valor máximo de algo
val Representa valor de
algo
Exemplos:
double minValPropriedade;
double maxValPropriedade;

19. Ferramentas apropriadas: editores
 Editores de código oferecem alguns recursos que permitem agilizar a
tarefa de escrita
 Recuos
 Auto completar;
 Code Templates;
 Gerador de interfaces;
 Demos

20. Dica2:
Use sua IDE com sabedoria

21. Documentação de código
 Muitas vezes a escrita organizada e clara não é suficiente;
 Existem muitos programadores que não se preocupam;
 Pequenas explicações podem economizar a leitura de dezenas de
linhas;
 Mas também deve-se ter o cuidado para não exagerar:
// incrementa o contador
++cont;

22. O que você deve
documentar
Ao estudar o funcionamento de um
programa, um desenvolvedor precisa
compreendê-lo inicialmente como um todo
e, depois entender a operação de cada
componente.

23. Ferramentas de documentação
 Doxygen
 gera diagramas de herança e chamadas de sub-rotinas;
 declarações de estruturas de dados;
 e listas alfabéticas de sub-rotinas, variáveis, módulos, etc.).
 JavaDoc
 NaturalDoc

24. Reaproveitamento de código
Princípio: Problemas que já foram solucionados no passado não devem
ser resolvidos novamente.
 É comum que os membros de uma equipe usem funções comuns;
 Evita perda de tempo com replicação de código já existente;
Solução: criação de repositório de funções;

25. Reuso de trechos de código
 Copiar código é, muitas vezes, uma excelente solução.
 Representa economia de tempo e custo;
 A solução já pode ter sido testada, tornando essa fase desnecessária;
 Testes de integração ainda podem ser necessários;
 Exemplo: Integração de um sistema de chat “pronto” a um sistema
em desenvolvimento.

26. Comunidades de desenvolvedores
A internet é uma fonte repleta de possibilidades:
 Tutorias;
 Programas completos;
 Bibliotecas de funções.

27. Comunidades de desenvolvedores
 http://www.codeguru.com
 http://www.codeproject.com
 http://www.codes-sources.com
 http://www.linhadecodigo.com.br
 http://pt.stackoverflow.com **

28. Bibliotecas
Há bibliotecas para uma grande diversidade de áreas:
 Acesso a Banco de dados
 Compressão e criptografia;
 Construção de interface;
 Comunicação em rede;
 Cálculo numérico;
 Manipulação gráfica 2D e 3D;

29. Exemplos de biblitotecas
 DigestUtils (Operações para simplificar a geração de hash em java)
String digest = DigestUtils.sha256Hex(pass);
 JPA (Javax Persistence API) (Mapeamento Objeto Relacional)
@Column(name "EMAIL", length = 100, nullable = false, unique = true)
public String getEmail() {
return email;
}

30. Programação defensiva
Basicamente se traduz em aumentar o controle sobre a execução do
programa.

31. Entrada de Dados
 Baseia-se na ideia de que um programa não deveria aceitar entradas
erradas em nenhuma hipótese.
 É preciso prever como tratar os erros para proteger a execução da
rotina
float raiz(float n){
return (n > 0)?sqrt(n) : -1.0;
}
....
Z = x *(x -1.0) / raiz(y);

32. Exceções
Exceção é uma condição inesperada que causaria uma falha no programa.
 Todas as situações podem ser tratadas por comandos if, porém leva a um
código confuso;
 Em algumas situações configuram ruído de programação;
 O tratamento de exceção provê uma solução mais limpa;
....
Try{
int teste = Integer.parseInt(valorDigitado);
}catch(NumberFormatException ex){
System.err.println(“Erro de conversão” +ex.getMessage());
}
....

33. Por fim
 O estilo de codificação não se relaciona apenas aos algoritmos, mas
também a forma como é escrito;
 É preciso haver equilíbrio entre otimização e legibilidade;
 As linguagens são repletas de funções e bibliotecas criadas para os
mais variados propósitos (Não precisa reinventar a roda);
 Um texto corretamente documentado, organizado, com
identificadores claros auxilia bastante o programador em seu
trabalho;

34. Referências
 KOSCIANSKI, André. Qualidade de Software: aprenda as metodologias
e técnicas mais modernas para o desenvolvimento de software. 2º Ed.
– São Paulo: Novatec Editora, 2007