Wiki
Convenção desenvolvedor/Convenção código/Declarações
Declarações #
Quantidade por linha #
Manter apenas uma declaração por linha é recomendado uma vez que isso encoraja a adição de comentários. Em outras palavras, é preferido utilizar o código a seguir:
int nivel; // nível de indentação int tam; // tamanho da tabela
ao invés deste outro formato mais compacto:
int nivel, tam; // EVITAR!
Não coloque diferentes tipos de dados na mesma linha, especialmente em se tratando de arrays. Por exemplo:
String nome, listaMetodos[]; // EVITAR!
Ainda considerando arrays, durante a declaração os colchetes devem ser posicionados junto ao tipo de dado, e não ao nome da variável. Seguem exemplos:
Double[] mensalidades; // PREFERIDO Double mensalidades[]; // EVITAR!
Disposição #
Coloque declarações apenas no início dos blocos. Lembre que um bloco é definido pelo código que está entre as chaves “{” e “}”. Não espere a variável ser usada a primeira vez para declará-la ou inicializá-la, pois isso pode confundir um programador desatento ou ainda comprometer a portabilidade do código. Veja um exemplo:
void meuMetodo() { int int1; // início do bloco do método if (condição) { int int2; // início do bloco da condição ... } }
A única exceção a esta regra são os índices de laços de repetição for, que em Java podem ser declarados na própria instrução. Por exemplo:
for (int i = 0; i < maxLoops; i++) { ...
Evite declarações locais que escondem declarações de níveis maiores. Por exemplo, não declare o mesmo nome de variável em um bloco interno:
int cont; ... metodo() { if (condição) { int cont; // EVITAR! ... } ... }
Inicialização #
Tente inicializar variáveis locais onde elas são declaradas. A única razão para não inicializar uma variável onde ela é declarada é se o valor inicial depende previamente de outro processamento .
Declarações de classe, interface, enumeração e anotação #
Quando estiver codificando classes, interfaces, enumerações e anotações em Java, as seguintes regras de formatação devem ser seguidas:
- não manter espaços entre um método e o parêntese “(” que inicia a sua lista de parâmetros;
- o sinal de abertura de chave “{” deve aparecer no final da mesma linha da declaração da instrução, indicando o início do bloco;
- o sinal de fechamento de chave “}” deve aparecer no final do bloco da instrução, sendo indentada de acordo com esta última, exceto no caso em que instrução é nula, e sendo assim a chave fecha logo após a abertura por “{”;
- métodos devem ser separados por uma linha em branco.
Veja um exemplo de código devidamente formatado de acordo com as regras acima:
class Exemplo extends Object { int ivar1; int ivar2; Exemplo(int i, int j) { ivar1 = i; ivar2 = j; } int metodoVazio() {} ... }
Declarações de atributos #
Todos os atributos devem ser declarados com o modificador private (privado) ou protected (protegido) a fim de serem complacentes com as regras de encapsulamento da programação orientada a objetos. O uso de atributos com o modificador public deve ser excepcional e bem justificado. Atributos protegidos devem ser preferidos sobre os públicos, sendo que os primeiros podem ser usados para variáveis a serem acessadas diretamente pelas classes derivadas.