CONVENÇÃO DE CÓDIGO JAVA

Projeto Mapeamento de Onibus

1 – Comentários Iniciais
Devem ser escritos no início da classe, antes do package
/*
* Nome da Classe
*
* Versão
*
* Alterações na classe
*
*/

2 – Importações de código
Evitar o uso de * no import.
Certo: import javax.servlet.http.HttpSession
Errrado: import javax.servlet.*

Package default:
br.ufal.ic.projetobusao
Exemplo:
br.ufal.ic.projetobusao.classes
br.ufal.ic.projetobusao.paginas
br.ufal.ic.projetobusao.configuracoes

3 – Declaração de Classe ou Interface

1 – Comentário Javadoc da classe ou interface.
/*
* Nome da Classe e descrição
* @version
* @author
*/

2 - Declaração da classe ou interface.

Exemplo:
public class NomeDaClasse {

3 – Comentário da implementação (Caso seja necessário)

/*...............*/

4 – Variáveis de classe (static)

Exemplo:
static {
PropertyConfigurator.configure("/var/jakarta-tomcat-5.5.9/webapps/
congressoweb/WEB-INF/classes/log4j.properties");
}

5 – Variáveis de Instância (Primeiro public, protected e private)

Exemplo:
 public int intVariavel;
protected String strVariavel;
private Object objVariavel;

6 - Construtor(es)
Exemplo:
public NomeDaClasse() {
...
}

7 – Métodos (Os métodos get e set devem ser agrupados em pares e o restante
agrupados em funcionalidades)

4 – Endentação
Máximo de 80 caracteres para cada linha de código.
Máximo de 70 caracteres para a linha de comentário.

Quebra de linha
Quando uma expressão não couber numa única linha, quebre a partir desses
princípios gerais.
- quebre após uma vírgula;
- quebre após um operador;
- Alinhe a nova linha com o inicio da expressão de mesmo nível da linha acima.

Ex.: public String metodoComMuitosParametros(String parametro1,

String parametro2,
String parametro3) {
...
}

Certo:
int resultado = (numero1 + numero2 + numero3 + numero4)
- numero5 * (numero6 / numero7);

OBS: A quebra deve ocorrer com o operador de maior nível.

5 – Comentários

Comentário de Bloco ou de linha – utiliza-se /* */

/*comentário*/

/*
* comentários
*
*/

Exemplo:

/* Caso a seja menor que b*/

if (a < b) {
 c=a*b
}

Comentário após código – utiliza-se //

Exemplos:
soma = (numero1 + numero2 + numero3 + numero4); // comentário

if (a < b) {
c = a * b // Multiplicando a e b
}

6 – Declarações
Obrigatoriamente devemos fazer uma declaração por linha.

Certo:
int a;
int b;

Errado:
int a, b;

Localização das declarações

Todas as declarações devem ser feitas no inicio do bloco respeitando o 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.
}
}

A única exceção se aplica no caso do comando for

Exemplo:
for (int i = 0; i < contador ; i++) {
..............
}

Deve ser evitado colocar o mesmo nome em variáveis de escopo diferente.

Exemplo:
int a;

if (condição) {
int a;
}

Tente inicializar a variável no momento da sua criação.

Exemplo:
int a = 0;
int b = 0;
 Declaração de Classe, Interface e Métodos
Não deve haver espaço entre o nome do método e o seu parêntese.
Certo:
public void nomeMetodo() {
Errado:
public void nomeMetodo () {

O abre chave { deve aparecer no final da mesma linha da declaração do método.

Certo:
public void nomeMetodo() {
Errado:
public void nomeMetodo(){

O fecha chave deve aparecer iniciando uma nova linha.

Certo:
public void nomeMetodo() {
...
}
Errado:
public void nomeMetodo() {
if (condição) {
int a;
}}

Existe uma exceção apenas quando se escreve métodos vazios, onde o fecha
chave deve aparecer após o abre chave {
Exemplo:
public void nomeMetodo() {}

7 – Exemplos de Códigos
if
Exemplo:
if (condição) {
...código
}

if-else
Exemplo:
if (condição) {
...código

} else {
...código
}
if-else-if-else
Exemplo:
if (condição) {
...código

} else if (condição) {
...código

} else if (condição) {
...código
}

for
Exemplo:
for (inicialização; condição; atualização) {
...código
}

while
Exemplo:
while (condição) {
...código
}

do-while
Exemplo:
do {
...código

} while (condição) ;

switch
Exemplo:
switch (condição) {
case ABC:
...código
break;

case XYZ:
...código
break;
default:
...código
break;
}

try-catch
Exemplo:
try {
...código

} catch (Exception e) {
...código
}
8 – Linhas em Brancos
Entre as definições de classe e interface.

Entre Métodos.
Exemplo:
public void nomeMetodo1() {
int a;
int b;

if (condição) {
int c;
}
}

public void nomeMetodo2() {

int a;
int b;

if (condição) {
int c;
}
}

Entre variáveis locais e o código do método.

Exemplo:
public void nomeMetodo() {
int a;
int b;

if (condição) {
int c; //Variável utilizada apenas dentro do if.
}
}

9 – Convenções de Nomes
Classes ou Interfaces
Os nomes devem iniciar com maiúscula e serem substantivos.
Exemplos:
class Empresa {
class Linha {
class Administrador {
class Terminal {
 Métodos
O nome deve ser um verbo e iniciar com letra minúscula.
Exemplos:
mapearPontos() {
alterarRaio() {
listarOnibus() {

Variáveis
Os nomes devem iniciar com letra minúscula.
Exemplo:
int numeroLinha;
int nomeLinha;

Constantes
O nome deve ser todo em letra maiúscula.
Exemplo:
int DISTANCIA_MINIMA = 30;
String NOME_SISTEMA = 'BUSAO';

10 – Codificação
JAVA
Nome de variáveis
String - Iniciar com “str”
Exemplos:
strNomeEmpresa
strNomeAdministrador

int - Iniciar com “int”

Exemplos:
intNumeroOnibus
intCodigoTerminal

boolean - Iniciar com “boo”

Exemplos:
booLogado
booErrado

Collection - Iniciar com “col”

Exemplos:
colOnibus
colPontos

Vector - Iniciar com “vec”

Exemplos:
vecPontosDeReferencia
vecSenha
SQL

Nome do banco de dados

Todos os bancos de dados começarão com letra maiúscula e os restantes em minúsculas.

Para o banco de testes, o nome do banco de dados é BusaoTeste.
E para a implementação final o nome do banco é Busao.
Qualquer banco de testes será criado com a especificação acima seguida da palavra Teste,
como descrito e sem espaços.

Nome de tabelas no banco de dados

Os nomes das tabelas devem conter apenas letras maiúsculas e iniciar com uma sigla
do banco no qual ela pertence.
Exemplos:
Ponto de Referencia – BUSAO_PONTO_REFERENCIA
Empresa – BUSAO_EMPRESA

Nome de colunas das tabelas

Os nomes das colunas devem conter apenas letras maiúsculas e iniciar com uma sigla
composta de 3 letras que corresponde a natureza do tipo dos dados que serão inseridos na coluna.

PID - Chave primária (Exemplo: PID_ONIBUS)

FID – Chave estrangeira (Exemplo: FID_ROTA)
FLG – Valor booleano (Exemplo: FLG_ROTA)
NUM – Número (Exemplo: NUM_CPF)
DAT - Data (Exemplo: DAT_CRIACAO)
NOM – Nome (Exemplo: NOM_ADMINISTRADOR)
DSC – Descrição (Exemplo: DSC_EMPRESA)
CAT – Categoria (Exemplo: CAT_FROTA)
MID – Arquivo (Exemplo: MID_ARQUIVO)

OBS: os tipos de dados representados por NOM e DSC são strings e Num, em alguns
casos.