Perooo

Convenciones de Código para el lenguaje de programación

JAVA™
Revisado 20 Abril de 1999
por Scott Hommel
Sun Microsystems Inc.

Traducido al castellano 10 Mayo del 2001
por Alberto Molpeceres
http://www.javahispano.com

Convenciones de Código Java

Conveciones de código para el lenguaje de programación
Java TM
Revisado, 20 de Abril de 1999
Traducido al castellano, 10 de Mayodel 2001

1 Introducción
1.1 Por qué tener convenciones de código
1.2 Reconocimientos
1.3 Sobre la traducción

2 Nombres de ficheros
2.1 Extensiones de los ficheros
2.2 Nombres de ficheros comúnes

5
5
5
5

6
6
6

3 Organización de los ficheros

7

3.1 Ficheros fuente Java
3.1.1 Comentarios de comienzo
3.1.2 Sentencias package e import
3.1.3 Declaraciones de clases einterfaces

7
7
7
7

4 Indentación
4.1 Longitud de la línea
4.2 Rompiendo lineas

5 Comentarios
5.1 Formato de los comentarios de implementación
5.1.1 Comentarios de bloque
5.1.2 Comentarios de una línea
5.1.3 Comentarios de remolque
5.1.4 Comentarios de fin de linea
5.2 Comentarios de documentación

6 Declaraciones
6.1 Cantidad por línea
6.2 Inicialización
6.3 Colocación
6.4Declaraciones de clase e interfaces

7 Sentencias
7.1 Sentencias simples
7.2 Sentencias compuestas
7.3 Sentencias de retorno
7.4 Sentencias if, if-else, if else-if else
7.5 Sentencias for

9
9
9

12
12
13
13
13
13
14

15
15
15
15
16

17
17
17
17
17
18

3

Convenciones de Código Java
7.6 Sentencias while
7.7 Sentencias do-while
7.8 Sentencias switch
7.9Sentencias try-catch

8 Espacios en blanco
8.1 Líneas en blanco
8.2 Espacios en blanco

18
18
18
19

20
20
20

9 Convenciones de nombres

22

10 Hábitos de programación

24

10.1 Proporcionando acceso a variables de instancia y de clase
10.2 Referencias a variables y métodos de clase
10.3 Constantes
10.4 Asignaciones de variables
10.5 Hábitos varios
10.5.1 Paréntesis
10.5.2Valores de retorno
10.5.3 Expresiones antes de ‘?’ en el operador condicional
10.5.4 Comentarios especiales

11 Ejemplos de código
11.1 Ejemplo de fichero fuente Java

4

24
24
24
24
24
24
25
25
25

26
26

Convenciones de Código Java

Convenciones de código para el lenguaje de
programación Java
TM

1 - Introducción
1.1 Por qué convenciones de código
Las convencionesde código son importantes para los programadores por un gran número de
razones:
•

El 80% del coste del código de un programa va a su mantenimiento.

•

Casi ningún software lo mantiene toda su vida el auto original.

•

Las convenciones de código mejoran la lectura del software, permitiendo entender
código nuevo mucho más rapidamente y más a fondo.

•

Si distribuyes tu códigofuente como un producto, necesitas asegurarte de que esta
bien hecho y presentado como cualquier otro producto.
Para que funcionen las convenciones, cada persona que escribe software debe seguir la
convención. Todos.

1.2 Agradecimientos
Este documento refleja los estandares de codificación del lenguaje Java presentados en Java
Language Specification , de Sun Microsystems, Inc. Los mayorescontribuidores son Peter
King, Patrick Naughton, Mike DeMoney, Jonni Kanerva, Kathy Walrath, y Scott Hommel.
Este documento es mantenido por Scott Hommel. Enviar los comentarios a
shommel@eng.sun.com

1.3 Sobre la traducción
Este documento ha sido traducido al español por Alberto Molpeceres, para el sitio web
javaHispano (www.javaHispano.com), y se encuentra ligado al objetivo de dicha webpara
fomentar el uso y conocimiento del lenguaje Java dentro del mundo hispano-hablante.
Se ha intentado hacer una traducción lo más literal posible, y esta es la única parte del
documento que no pertenece a la versión original.
Se pueden enviar los comentarios sobre la traducción a la dirección: al@javahispano.com

5

Convenciones de Código Java

2 - Nombres de ficheros
Esta sección...