Universidad Metropolitana

Estructura de Datos
Convenciones para programacin en Java
Gua

Seguir los siguientes parmetros:

1. Evitar en lo posible definir variables globales.
2. No referirse a valores constantes directamente en el cdigo, ms bien
utilizar el operador final de Java para declarar constantes.
3. Proveer comentarios en cada lnea de cdigo oscuro o que sea difcil de
leer.
4. Limitar todos los mtodos a que realicen solo una tarea y moderar el
nmero de lneas de cada mtodo (< 20 lneas).
5. Utilizar una indentacin consistente.
6. Utilizar el siguiente bloque de comentario como plantilla para cada clase
declarada:
/**
* Nombre de la clase
* Breve explicacin del concepto que se define con la clase
*
* @author Leila Escalona
* @version 1.00, 13/09/2015
*
*/

7. Utilizar el siguiente bloque de comentario por cada mtodo o

procedimiento que se realiza:
/**
* Nombre del Metodo
* Breve explicacin de lo que hace
*
* @param nombre Explicacin y tipo
* @param nombre Explicacin y tipo
*
* @return Explicacin del valor de
*/

el metodo
de parmetro
de parmetro
retorno del mtodo

8. Cada clase ser almacenada en un archivo, y cada archivo contendr solo

una clase.
9. Todos los atributos de una clase debern ser definidos con el operador
private para as poder implementar un esquema puro de intercambio de
mensajes y el encapsulamiento.
10. Los mtodos de acceso (get) y de modificacin (set) debern ser
definidos slo para aquellos atributos que necesiten ser accesados por
otras clases.
11. Utilizar identificadores descriptivos para el nombre de mtodos y
atributos, evitando as abreviaciones crpticas.
12. Utilizar mayscula para la primera letra de cada clase (Ej: Rectangulo)
13. Utilizar minscula para la primera letra de cada mtodo
(Ej: dibujaRectangulo()).
14. Capitalizar la primera letra de a partir de la segunda palabra en un
nombre compuesto
(Ej: entradaDatos, coordenadaX)
15. Todos los atributos o miembros de una clase debern comenzar con _
(Ej: _nombre, _clave).
16. Comenzar cada atributo o variable local con letra minscula (Ej: _clave,
_cedulaIdentidad)
A continuacin se muestra el esqueleto de un cdigo que sigue con las
convenciones mencionadas anteriormente.

/**
* Complejo
* Clase que contiene los atributos y las operaciones
* necesarias para la creacion y manipulacion de numeros complejos
* @author Leila Escalona
* @version 1.00, 13/09/2015
*
*/
public class CComplejo
{
private int _real; // parte real del numero complejo
private int _imag; // parte imaginaria del numero complejo
/**
* Complejo
* Constructor que inicializa el numero complejo a
* los dos valores que recibe como parametros
* @param r el valor de la parte real
* @param i el valor de la parte imaginaria
*
*/
public Complejo( int r, int i )
{
_real = r;
_imag = i;
}
/**
* SetReal
* Metodo para modificar la parte real de un numero complejo
* @param nuevo valor de la parte real
*
*/
public void setReal( int valorR )
{
_real = valorR;
}
* GetReal
* Metodo que devuelve la parte real de un numero complejo
* @return un entero
*
*/
public int getReal()
{
return _real;
}

/**
* Imprime
* Metodo para imprimir un numero complejo por pantalla
*
*/
public void imprime()
{
System.out.println( mReal + " + " + mImag + "i" );
}
/**
* Suma
* Metodo que suma dos numeros complejos
*
* @param el segundo numero complejo a sumar
*
* @return el resultado de la suma
*
*/
public Complejo suma( Complejo num )
{
Complejo resultado = new Complejo(); resultado.SetReal( GetReal() +
num.GetReal() );
resultado.SetImag( GetImag() + num.GetImag() );
return resusltado;
}
}// fin de la clase