Boas Práticas

No modo Geral

Boas Práticas é uma expressão derivada do inglês “best practise”,a qual

denomina tecnicas indentificadas como as melhores para realizar
determinada tarefa.
No contexto de programação
São conjunto de convenções para poder tornar o codigo de
computador legível tanto para computadores como humanos, afim de
que a sua manutenção e melhorias possam ocorrer mais facilmente.
Exemplos de boas práticas de
programação:
• Identação de codigo;
• Nomeação de variaveis de maneira intuitiva;
• Evitar condição de negaçãp no “if’’ ;
• Backup/ restore;
• Tamanho;
• Comentar e documentar o codigo.
Identação de código
A identação do código é um dos itens mais básicos e ao mesmo tempo
importante para um programador.
• Nomeação de variáveis de maneira intuitiva
Nomear variaveis é tarefa simples,desde que se sigam as regras ou
restrições de cada linguagem. Mas é preciso declarar variaveis com
nomes intuitivos, prática que é pouco usada por programadores
iniciantes, até alguns especialidades:
Evitar condição de negação no “if”

Usando a estrutura de condição “if”, o objectivo deve ser sempre

avaliar uma condição verdadeira primeiro e caso falso executar o “else”
Bacup/ Restore
• Fazer a backup, com determinada frequencia(no final do dia ou
semanalmente)

Tamanho
• Evitar classes muito longas, por exemplo com mais de 1000 linhas.
Comentar e documentar código

• Explicar algoritimo ou lógica usada, mostrando o objectivo de uma

variavel, método, classe...;

• Documentar o projecto, descrevendo a especificação do código, para

que desta maneira qualquer pessoa possa analisar um arquivo de
documentação, mesmo que este não apresente o código fonte.
Documentação de Programas
É um texto escrito que acompanha o software e geralmente explica
como utilizá-lo. Os textos podem acompanhar uma função, uma classe
ou um simples trecho.
Um programa deve ser escrito para ser lido por pessoas e
eventualmente ser interpretado por computador ,assim sendo, é
essencial que um programa esteja bem documentado, pois esta é
principal fonte de informação que um programdor dispõe quando quer
(re) utilizar o código.
• Os comentarios no código fonte Java que constituem a documentação
devem ser delimitados por /** ...*/ para serem reconhecidos pelo
Javadoc.

Ex:
/**

*Formatação usual de um comentário

**/
Javadoc
Javadoc é um gerador de documentação criado pela Sub Microsystems
para documentar a API dos programas em Java a partir do código-fonte,
e o resulatado é expresso em HTML.
Algumas Tags úteis disponibilizadas pelo Javadoc:
  TAGS UTILDADE
 

@author  Nome do desenvolvedor

@exception Documenta uma exceção lançada por um método.Requerido para

cada parâmetro.
@return Documenta o valor de retorno. Essa tag não deve ser usada para
constructores ou métodos definidos com o tipo de retorno void.

@see  Documenta quando o método foi adicionado a classe

@throws  Documenta uma exceção lançada por um método. É um

Sinônimo para a @exception introduzida no javadocn1.2
  @version  Exibe o número da versão de uma classe ou um método.

@param Apenas para métodos e constructores: indica o nome de

argumentos de um método ou constructor e o respectivo
signigicado
Padrão MVC
Moddel-View-Controller, que em português significa Modelo-Visão-
Controle, é um padrão de arquitetura de software focado no reuso de
código e a separação de conceitos em tres camadas interconectadas.

• A apresentação dos dados de interação dos usuários (front-end) são

separados dos métodos que interagem com o banco de dados (back-
end).
Vantagens do padrão MVC:
• Manutenção do sistema se torna mais fácil;
• Facilita o reaproveitamento do código;
• Permite o desenvolvimento, testes e manunteção de forma isolada
entre as camadas;
Desvantagens
• Requer um tempo maior para explorar e modelar o sistema;
• Requer mão-de-obra especializada;
• Em sistemas de baixa necessidade o MVC pode criar uma
complexidade desnecessária;
• À medida que o tamanho e a complexidade do projeco crescem, a
quantidade de arquivos e pastas continuará aumentando também.
• Os interesses de UI (interface do usuário)(modelos,exibições,
contoladores) se localizam em várias pastas, que não são formadas
em grupos por ordem alfabética.
OBRIGADO!