Difference between revisions of "Convenções de escrita de programas em Java"

From Wiki**3

 
Line 1: Line 1:
 
Embora a linguagem Java tenha uma sintaxe e semântica bem definidas, decisões há que restrigem aqueles aspectos com o fim de melhorar a escrita de programas e, assim, a sua compreensão por um eventual leitor humano. Estas decisões são relativas a convenções de escrita, especialmente no que respeita a nomes de entidades que figuram num program. São as denominadas convenções de codificação e são inteiramente para consumo humano, já que para a máquina (i.e., para o compilador) são meros adornos, completamente irrelevantes do ponto de vista funcional.
 
Embora a linguagem Java tenha uma sintaxe e semântica bem definidas, decisões há que restrigem aqueles aspectos com o fim de melhorar a escrita de programas e, assim, a sua compreensão por um eventual leitor humano. Estas decisões são relativas a convenções de escrita, especialmente no que respeita a nomes de entidades que figuram num program. São as denominadas convenções de codificação e são inteiramente para consumo humano, já que para a máquina (i.e., para o compilador) são meros adornos, completamente irrelevantes do ponto de vista funcional.
  
As conveções dizem respeito a vários aspectos. São aqui resumidos os utilizados para:
+
As conveções dizem respeito a vários aspectos.
 +
 
 +
== Nomes ==
 +
 
 
* Constantes: todas as letras em maiúsculas; palavras separadas por "sublinhados" (underscores);
 
* Constantes: todas as letras em maiúsculas; palavras separadas por "sublinhados" (underscores);
** Exemplos: <code>MASSA_DO_ELECTRÃO</code>, <code>CONSTANTE_DE_PLANK</code>
+
** Exemplos <font color="green">bons</font>: <code>MASSA_DO_ELECTRÃO</code>, <code>CONSTANTE_DE_PLANK</code>
 +
** Exemplos <font color="red">maus</font>: <code>i</code>, <code>MinhaConstante</code>, <code>_outra_constante</code>
 
* Variáveis: há dois grupos a considerar: o primeiro corresponde a variáveis que são atributos de objectos, enquanto o segundo corresponde a variáveis locais a métodos. Apenas diferem na convenção por as primeiras serem precedidas por um "sublinhado". A convenção é que os nomes sejam iniciados por uma letra minúscula, sendo cada nova palavra do identificador marcada pelo uso de uma maiúscula:
 
* Variáveis: há dois grupos a considerar: o primeiro corresponde a variáveis que são atributos de objectos, enquanto o segundo corresponde a variáveis locais a métodos. Apenas diferem na convenção por as primeiras serem precedidas por um "sublinhado". A convenção é que os nomes sejam iniciados por uma letra minúscula, sendo cada nova palavra do identificador marcada pelo uso de uma maiúscula:
** Exemplos de atributos de um objectos: <code>_numeroDeDentes</code>, <code>_ratómetro</code>
+
** Exemplos de atributos de um objectos:
** Exemplos de variáveis locais e argumentos de métodos: <code>numeroDeSérie</code>, <code>i</code> (o uso de variáveis com nomes curtos deve ser limitado, tendo-se como boa utilização a utilização como contadores de iteração)
+
*** <font color="green">bons</font>: <code>_numeroDeDentes</code>, <code>_ratómetro</code>
 +
*** <font color="red">maus</font>: <code>MARIA</code>, <code>CoisaEstranha</code>
 +
** Exemplos de variáveis locais e argumentos de métodos:
 +
*** <font color="green">bons</font>: <code>numeroDeSérie</code>, <code>i</code> (o uso de variáveis com nomes curtos deve ser limitado, tendo-se como boa a utilização como contadores de iteração)
 +
*** <font color="red">maus</font>: <code>VARIÁVEL_LOCAL</code>, <code>número_de_série</code>, <code>número_De_Série</code>
 
* Classes: os nomes diferem dos das variáveis apenas por começarem por letra maiúscula.
 
* Classes: os nomes diferem dos das variáveis apenas por começarem por letra maiúscula.
 
** Exemplos: <code>RefeiçãoComSopa</code>, <code>LeãoDaMontanha</code>
 
** Exemplos: <code>RefeiçãoComSopa</code>, <code>LeãoDaMontanha</code>
 +
 +
== Identação ==
 +
 +
== Ver Também ==
 +
 +
* [http://mega.ist.utl.pt/~ic-po/2005/RegrasCodificacao.html Regras de codificação em Java]

Revision as of 21:00, 27 September 2005

Embora a linguagem Java tenha uma sintaxe e semântica bem definidas, decisões há que restrigem aqueles aspectos com o fim de melhorar a escrita de programas e, assim, a sua compreensão por um eventual leitor humano. Estas decisões são relativas a convenções de escrita, especialmente no que respeita a nomes de entidades que figuram num program. São as denominadas convenções de codificação e são inteiramente para consumo humano, já que para a máquina (i.e., para o compilador) são meros adornos, completamente irrelevantes do ponto de vista funcional.

As conveções dizem respeito a vários aspectos.

Nomes

  • Constantes: todas as letras em maiúsculas; palavras separadas por "sublinhados" (underscores);
    • Exemplos bons: MASSA_DO_ELECTRÃO, CONSTANTE_DE_PLANK
    • Exemplos maus: i, MinhaConstante, _outra_constante
  • Variáveis: há dois grupos a considerar: o primeiro corresponde a variáveis que são atributos de objectos, enquanto o segundo corresponde a variáveis locais a métodos. Apenas diferem na convenção por as primeiras serem precedidas por um "sublinhado". A convenção é que os nomes sejam iniciados por uma letra minúscula, sendo cada nova palavra do identificador marcada pelo uso de uma maiúscula:
    • Exemplos de atributos de um objectos:
      • bons: _numeroDeDentes, _ratómetro
      • maus: MARIA, CoisaEstranha
    • Exemplos de variáveis locais e argumentos de métodos:
      • bons: numeroDeSérie, i (o uso de variáveis com nomes curtos deve ser limitado, tendo-se como boa a utilização como contadores de iteração)
      • maus: VARIÁVEL_LOCAL, número_de_série, número_De_Série
  • Classes: os nomes diferem dos das variáveis apenas por começarem por letra maiúscula.
    • Exemplos: RefeiçãoComSopa, LeãoDaMontanha

Identação

Ver Também