Scribd
Carregar
58 visualizações

Convenções de Código Java

Enviado por

Robson Junior
Direitos autorais
© © All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd
58 visualizações

Convenções de Código Java

Enviado por

Robson Junior
Direitos autorais
© © All Rights Reserved
Levamos muito a sério os direitos de conteúdo. Se você suspeita que este conteúdo é seu, reivindique-o aqui.
Formatos disponíveis
Baixe no formato PDF, TXT ou leia on-line no Scribd
Você está na página 1/ 20

Prof. MSc.

Anderson Viçoso de Araújo


ƒ As convenções de código são uma boa
prática de programação;
ƒ Ajudam, por exemplo, na manutenção de um
sistema;
ƒ A violação dessas “regras” prejudica em
muito o entendimento de um código;
ƒ Com as convenções, se é capaz de produzir
um código legível, “limpo”, que demonstra
qualidade e de maneira profissional;
ƒ 80% do custo total de uma parte de um software é de
manutenção;
ƒ Dificilmente um software vai ser mantido pelo autor
original pela vida toda;
ƒ Deve‐se seguir uma convenção, pois outros
programadores podem dar manutenção no que vier a ser
construído depois;
ƒ Fácil entendimento por uma equipe de desenvolvimento;
ƒ Profissionalismo;
ƒ Uma aplicação possui um vida útil, e queremos que essa
vida seja longa;
ƒ Um software é um produto que deve possuir qualidade,
codificação limpa, fácil entendimento, fácil manutenção.
ƒ Deve obedecer a uma certa hierarquia, separada por pontos;
ƒ Deve‐se usar letras minúsculas e raramente se faz usos de números;
ƒ Se o pacote a ser utilizado é de fora da companhia ou organização, este
deve começar com o domínio de internet redigido de forma contrária.
ƒ Por exemplo, o pacote com.sun.
ƒ Essas “partes” devem ser curtas, com até oito caracteres;
ƒ As bibliotecas padrão e pacotes opcionais que começam com java e
javax, são exceções a esta regra e não são permitidos esses nomes para
uso do desenvolvedor;
ƒ São permitidas abreviações, como por exemplo, o pacote util ao invés de
utilities;
ƒ O uso de acrônimos também é visto com bons olhos.
ƒ Em java arquivos com a extensão .java são
denominados arquivos de código fonte;
ƒ Já arquivos com a extensão .class são
denominados arquivos de código de bytes ou
seja, os arquivo após a compilação.
Java Source .java
Java Bytecode .class
ƒ Pede‐se que seja evitado arquivos com mais
de 2000 (duas mil) linhas de código;
ƒ Cada arquivo fonte Java contém uma única
classe ou interface pública;
ƒ A classes privadas e as interfaces associadas a
classe pública podem ser colocadas em um
mesmo arquivo que uma classe pública;
ƒ A classe pública deve ser a primeira classe ou
interface no arquivo.
ƒ Devem ser escritos no início da classe, antes
da declaração do pacote (package);
/*
* Nome da Classe
*
* Versão
*
* Alterações na classe
*
*/
ƒ Os nomes devem consistir em uma ou mais
palavras, de preferência substantivos ou
frases substantivas;
ƒ Com a primeira letra de cada palavra em letra
maiúscula.
ƒ Abreviações devem ser evitadas;
ƒ Exemplo:
ƒ public class NomeDaClasse {
ƒ Comentário Javadoc da classe ou interface:

/**
* Nome da Classe e descrição
*
* @version
* @author
*/
ƒ Declarar uma declaração por linha:
ƒ Certo:
▪ int a;
▪ int b;
ƒ Errado:
▪ int a, b;
ƒ Se possível, inicializar a variável no momento da sua
criação;
ƒ Exemplo:
▪ int a = 0;
▪ int b = 0;
ƒ Evitar múltiplas atribuições na mesma linha:
ƒ Certo:
▪ a = 10;
▪ b = 10;

▪ a = b + c;
▪ d = a + r;
ƒ Errado:
▪ a = b = 10;

▪ d = (a = b + c) + r;
ƒ Nomes de variáveis (ou atributos) começam
com minúsculas e o início de cada palavra
seguinte com maiúscula:
ƒ Exemplo:
public int nomeDaVariavel;

ƒ Constantes:
ƒ O nome deve ser todo em letra maiúscula;
ƒ Exemplo:
final int DISTANCIA_MINIMA = 30;
final String NOME_SISTEMA = “BUSAO”;
ƒ Nomes dos métodos também seguem a
padronização similar a de variáveis;
ƒ Os métodos normalmente utilizam verbos ou frases
verbais;
ƒ Métodos que retornem um tipo booleano devem
usar prefixo "is" seguido de um substantivo ou
adjetivo;
ƒ Exemplos:
public void nomeDoMetodo() {
}

public boolean isEmpregado(){


}
ƒ Os métodos que retornam o resultado de
uma função ou um atributo do objeto são
nomeados com substantivos com o prefixo
"get“;
ƒ Os métodos para atribuir o valor a um
atributo do objeto são nomeados com
substantivos com o prefixo “set“;
ƒ Em relação a JavaBeans, o uso do get e set
são obrigatórios;
ƒ Comentário Javadoc do método:

/**
* Nome do método e descrição
*
* @param nomeParam Descrição do Parâmetro
* @return Descrição do retorno
*/
ƒ Todas as declarações devem ser realizadas no
inicio do bloco do seu escopo;
ƒ Exemplo:
public void nomeMetodo() {
int a; //Essas variáveis serão usadas em todo
o escopo do método
int b;

if (condição) {
int c; //Variável utilizada apenas
dentro do if.
}
}
ƒ Deve‐se evitar colocar o mesmo nome em
variáveis de escopos diferentes;
ƒ Exemplo:

int a;

if (condição) {
int a;
}
ƒ Evitar:
if (booleanExpression) {
return true;
} else {
return false;
}

ƒ Preferir:
return booleanExpression;
ƒ Usar comentários especiais para definir pontos
de atenção dentro do código;
ƒ //FIXME:
ƒ Usar quando foi identificado um erro, que deve ser
corrigido mais tarde;
ƒ //TODO:
ƒ Usar quando alguma tarefa ainda está pendente de
ser executada naquele ponto do código;
ƒ //XXX:
ƒ Corresponde a uma parte do código que está mal
feita, precisa ser refeito, mas está funcionando;
ƒ Para verificar a utilização das convenções,
podemos abrir o código fonte do Java escrito
por programadores da Sun;

Você também pode gostar