resumen

Convenciones de Código Java
Vladimir Costas
FCyT-UMSS

2013

Vladimir Costas ( FCyT-UMSS )

Convenciones de Código Java

2013

1 / 20

Introducción

Las personas que construyen programas deben considerar:
Que otros programadores leerán su código
Los programas, sobre todo los grandes, necesitan mantenimiento
Escribir código limpio indica buenas costumbres y limpieza en eltrabajo
Todo producto va acompa nado de especificaciones técnicas...

Vladimir Costas ( FCyT-UMSS )

Convenciones de Código Java

2013

2 / 20

Convenciones de código Java

Las convenciones de código ayudan a:
Mejorar la legibilidad del código escrito
que otros programadores entiendan el código
Reducir costos de mantenimiento del programa (80 % del costo
de un producto de software esmantenimiento )
...
Lo que se verá es el estándar para escribir código presentado por Sun.

Vladimir Costas ( FCyT-UMSS )

Convenciones de Código Java

2013

3 / 20

Nominación de Archivos

Usar siempre los sufijos: .java para código fuente Java, y .class
para Java byte code.
Cada archivo con extensión .java debe llevar el nombre de la
Clase que contiene (es buena costumbre que unarchivo
contenga sólamente una clase).
Obviamente archivos .class llevarán el nombre de su
correspondiente fuente (archivo .java)

Vladimir Costas ( FCyT-UMSS )

Convenciones de Código Java

2013

4 / 20

Reglas de nominación

Paquetes en minúsculas y código ASCII,
com.sun.eng
Clases Sustantivos, si son compuestos, cada palabra interna
comienza con mayúscula. La primera letracon
mayúscula, el resto minúsculas,
class Persona, class CadenaComunicacion
interfaces igual que clases
Atributos Nombres cortos, en minúsculas, si son compuestas cada
palabra interna comienza en mayúscula. No deben
empezar con $ ni _,
Date fechaNacimiento;, int numero;

Vladimir Costas ( FCyT-UMSS )

Convenciones de Código Java

2013

5 / 20

Reglas de nominación
Atributosestáticos Siempre en mayúsculas, y palabras separadas por
_,
static final int MAX_VALOR = 100;
Constantes idem Atributos estáticos,
final int MIN_VALOR = 0;
Metodos Verbos con primera letra en minúsculas, si son
compuestos cada palabra interna en mayúsculas,
encadenar(...);,
imprimirCadena();
Los nombres deben ser descriptivos, evitar abreviaciones (A menos
que sean muy conocidas). Los nombresde atributos deben, en lo
posible ser cortos.

Vladimir Costas ( FCyT-UMSS )

Convenciones de Código Java

2013

6 / 20

Contenido de un .java

1

Información del archivo: Nombre de la clase, copyright, resúmen
de actualizaciones, etc.

2

Declaraciones de paquetes (package) y contenido a importarse
(import)

3

La Clase o Interfaz declarada

Un archivo .java DEBEcontener sólamente una clase o interface
pública
Si existen clases o interfaces privadas asociadas, pueden estar al final
del archivo.

Vladimir Costas ( FCyT-UMSS )

Convenciones de Código Java

2013

7 / 20

Información del archivo .java

Debe contener, en un bloque de comentario, la siguiente información:
1

Nombre de la clase

2

Versión y fecha

3

Información general4

Autor

5

Resúmen de actualizaciones (Fecha, descripción, autor)

6

Copyright

Vladimir Costas ( FCyT-UMSS )

Convenciones de Código Java

2013

8 / 20

Declaraciones package e import

1

Declaración package: Se crea un paquete para cada grupo de
clases que se relacionan por su uso/funcionalidad. Nombres de
paquetes siempre van en minúsculas

2

Declaracionesimport: Cada declaración import se refiere a un
elemento en particualr (evitar el uso de *)

Vladimir Costas ( FCyT-UMSS )

Convenciones de Código Java

2013

9 / 20

Declaración de Clase o Interface

El contenido de la declaración de una clase o interface se entrelaza
con su documentación (JavaDoc):
1
2

Documentación de la clase o interface (/** ... */)
Declaración class o...