convenios

Convenios de programación en Java

En este apéndice se incluye un conjunto de reglas que le permitirán seguir un estilo de programación uniforme para
que sean fáciles de entender y corregir sus programas. Tener unas reglas para programar es importante porque:
•
•
•
•

La mayor parte del tiempo se dedica a leer programas, por lo que resulta importante que sean fáciles de leer y
deentender.
Seguir unas reglas de programación permite mejorar la legibilidad del código escrito y entender fácilmente el
código que no es de uno mismo.
Si se da código propio a terceras personas, o se intenta explicar lo que se ha hecho, será más fácil de entender
si se ha seguido un estilo consistente y similar, o igual, al de otros programadores.
Casi nunca ocurre que todo el código que utilizapara un programa sea escrito por un solo programador, sino
que se habrá desarrollado por un grupo de programadores.

Este apéndice se ha estructurado teniendo en cuenta los distintos elementos del lenguaje a considerar. Al principio
pueden parecerle demasiadas cosas. Empiece por unas pocas y vaya leyendo nuevas guías de codificación según vaya
ganando confianza con el lenguaje y conozca yaplique bien las anteriores.

8.1

ESTRUCTURADE UN ARCHIVO FUENTE EN JAVA

Todo archivo fuente en Java tendrá la siguiente estructura:
•
•
•
•

Comentario inicial: Cada archivo fuente contendrá un comentario inicial donde se describirá el objetivo de
dicho archivo.
Sentencia de paquete, si existe.
Importación de las clases que se utilizan en esta clase.
Declaración de clases einterfaces, que deberán aparecer en el siguiente orden:
- Comentario de documentación de la clase o interfaz.
- Sentencia de declaración de la clase o interfaz.
- Atributos estáticos, primero los públicos, después los protegidos, después los de paquete y por último los
privados.

----

.•

 36) {
ll Hace algo con la variable dada
haceAlgoCunaVariable):
} else {
haceOtraCosaC):
ll Hace otracosa

B.4

DECLARACIONES

Las declaraciones deberían hacerse una por línea, ya que facilita su documentación. Si alinea a la izquierda los
nombres de las variables pueden resultar más fáciles de leer, aunque debe considerar cada caso.

int
pesoDeclarado:
int
pesoRea 1 :
ListaMia unaLista:
Excepciones son: las declaraciones
auxiliares:

en la cláusula de inicialización

de un fory las declaraciones

de variables

int ancho. alto:
for Cint i=O. j=l:
En ningún caso se utilizarán declaraciones en la misma línea de elementos que son de distinto tipo lógico, por
ejemplo un entero y un array de enteros.

int numeroDeEleruentos. valoresReales[]:
int numeroDe Elementos:
int valoresReales[]:

IIEVITAR

Aunque lava permite declarar variables en cualquier punto delcódigo, hágalo preferiblemente sólo al principio de
un bloque.
Evite declarar una variable en un bloque interno que oculte una declaración de un bloque exterior.

public int funcion Cint a) {
int varl:
if Ca > 2) {
int varl:

B.5

ll dar un nombre diferente

ESPACIO EN BLANCO

El espacio en blanco no es un espacio desperdiciado. Resulta un espacio importante para separar unoselementos de
otros de manera que sea fácilmente identificable lo que va junto y, por tanto, está relacionado y lo que se puede
separar. Además de separar grupos de sentencias añada una línea en blanco:
•
•

Separando dos métodos dentro de una clase.
Entre la declaración de atributos de una clase y sus constructores y métodos.

Convenios de programación en Java
•
•

----

•.

Entre ladeclaración de variables locales de un método y la parte de ejecución.
Antes de un comentario dentro del código.

if (condicion)
sentencias

// Ahora se ve cuando se termina de repetirlo
while (otracondición)
sentencias

•

Para separar código en trozos funcionales

if (n < O) {
threw new Exception("Error en entrada")

l/cálculo de factorial
for (int i= 1: i < n: i++)

En...