Convenção desenvolvedor/Convenção código/Declarações

Convenção desenvolvedor/Convenção código/Declarações 1.1 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:47 GMT

Linha 1

<<TableOfContents>>

Linha 2

Linha 3

==Declarações==

Linha 4

Linha 5

Linha 6

===Quantidade por linha===

Linha 7

Linha 8

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:

Linha 9

Linha 10

}

Linha 11

Linha 12

ao invés deste outro formato mais compacto:

Linha 13

Linha 14

}

Linha 15

Linha 16

Não coloque diferentes tipos de dados na mesma linha, especialmente em se tratando de arrays. Por exemplo:

Linha 17

Linha 18

}

Linha 19

Linha 20

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:

Linha 21

Linha 22

}

Linha 23

Linha 24

Linha 25

===Disposição===

Linha 26

Linha 27

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:

Linha 28

Linha 29

}

Linha 30

Linha 31

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:

Linha 32

Linha 33

}

Linha 34

Linha 35

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:

Linha 36

Linha 37

}

Linha 38

Linha 39

Linha 40

===Inicialização===

Linha 41

Linha 42

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 .

Linha 43

Linha 44

Linha 45

===Declarações de classe, interface, enumeração e anotação===

Linha 46

Linha 47

Quando estiver codificando classes, interfaces, enumerações e anotações em Java, as seguintes regras de formatação devem ser seguidas:

Linha 48

Linha 49

* não manter espaços entre um método e o parêntese “(” que inicia a sua lista de parâmetros;

Linha 50

* 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;

Linha 51

* 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 “{”;

Linha 52

* métodos devem ser separados por uma linha em branco.

Linha 53

Linha 54

Veja um exemplo de código devidamente formatado de acordo com as regras acima:

Linha 55

Linha 56

}

Linha 57

Linha 58

}

Linha 59

Linha 60

}

Linha 61

Linha 62

}

Linha 63

Linha 64

Linha 65

===Declarações de atributos===

Linha 66

Linha 67

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.

Linha 68

Linha 1

~~New~~

Convenção desenvolvedor/Convenção código/Declarações 1.2 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:48 GMT

Convenção desenvolvedor/Convenção código/Declarações 1.3 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:48 GMT

Convenção desenvolvedor/Convenção código/Declarações 1.4 (Edição mínima)

Test Test — Wed, 09 Jan 2013 20:00:48 GMT

Convenção desenvolvedor/Convenção código/Declarações 1.5

Test Test — Fri, 05 Apr 2013 16:18:58 GMT

Linha 3

==Declarações==

== Declarações ==

Linha 4

=== Quantidade por linha ===

Linha 6

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:

Linha 6

~~===Quantidade por linha===~~

Linha 9

{{{

Linha 10

int nivel; // nível de indentação

Linha 11

int tam; // tamanho da tabela

Linha 12

}}}

Linha 8

~~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:~~

Linha 10

}

Linha 15

Linha 14

}

Linha 19

{{{

int nivel, tam; // EVITAR!

}}}

Linha 18

}

Linha 28

{{{

String nome, listaMetodos[]; // EVITAR!

}}}

Linha 22

}

Linha 37

{{{

Double[] mensalidades; // PREFERIDO

Double mensalidades[]; // EVITAR!

}}}

Linha 25

~~===Disposição===~~

Linha 43

=== Disposição ===

Linha 47

{{{

void meuMetodo() {

int int1; // início do bloco do método

if (condição) {

int int2; // início do bloco da condição

...

}

Linha 56

}}}

Linha 58

Linha 33

}

Linha 63

{{{

for (int i = 0; i < maxLoops; i++) { ...

}}}

Linha 71

{{{

int cont;

...

metodo() {

if (condição) {

int cont; // EVITAR!

...

}

...

Linha 82

}}}

Linha 40

Linha 85

===Inicialização===

=== Inicialização ===

Linha 89

=== Declarações de classe, interface, enumeração e anotação ===

Linha 45

~~===Declarações de classe, interface, enumeração e anotação===~~

Linha 98

Linha 101

{{{

class Exemplo extends Object {

int ivar1;

int ivar2;

Exemplo(int i, int j) {

ivar1 = i;

ivar2 = j;

}

int metodoVazio() {}

...

Linha 116

}}}

Linha 57

Linha 58

}

Linha 59

Linha 60

}

Linha 61

Linha 62

}

Linha 65

Linha 119

===Declarações de atributos===

=== Declarações de atributos ===

Linha 68