Convenciones_Codigo_Java.pdf

(151 KB) Pobierz
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
Revisión y corrección, marzo de 2007
por Lucas Vieites
http://www.codexion.com
Convenciones de código para el lenguaje de programación Java
2/22
Convenciones de código para el lenguaje de programación Java
Convenciones de código para el lenguaje de programación
Java
TM
Revisado, 20 de Abril de 1999
Traducido al castellano, 10 de Mayo del 2001
Revisión y corrección, marzo de 2007
Índice de contenido
1
Introducción.....................................................................................................................5
1.1
Por qué convenciones de código......................................................................................................5
1.2
Agradecimientos..............................................................................................................................5
1.3
Sobre la traducción..........................................................................................................................5
2
Nombres de archivo..........................................................................................................5
2.1
Extensiones de los archivos.............................................................................................................5
2.2
Nombres de archivo comúnes.........................................................................................................6
3
Organización de los archivos.............................................................................................6
3.1
Archivos de código fuente Java........................................................................................................6
3.1.1
Comentarios de inicio..............................................................................................................6
3.1.2
Sentencias package e import..................................................................................................7
3.1.3
Declaraciones de clases e interfaces.......................................................................................7
4
Indentación......................................................................................................................7
4.1
Longitud de la línea.........................................................................................................................8
4.2
Rotura de líneas..............................................................................................................................8
5
Comentarios.....................................................................................................................9
5.1
Formatos de los comentarios de implementación..........................................................................10
5.1.1
Comentarios de bloque..........................................................................................................10
5.1.2
Comentarios de una línea......................................................................................................11
5.1.3
Comentarios finales...............................................................................................................11
5.1.4
Comentarios de fin de línea...................................................................................................11
5.2
Comentarios de documentación....................................................................................................11
6
Declaraciones.................................................................................................................12
6.1
Cantidad por línea.........................................................................................................................12
6.2
Inicialización..................................................................................................................................13
6.3
Colocación.....................................................................................................................................13
6.4
Declaraciones de clases e interfaces.............................................................................................13
7
Sentencias.....................................................................................................................14
7.1
Sentencias simples........................................................................................................................14
7.2
Sentencias compuestas.................................................................................................................14
7.3
Sentencias de retorno....................................................................................................................14
3/22
Convenciones de código para el lenguaje de programación Java
7.4
Sentencias if, if-else, if else-if else.................................................................................................14
7.5
Sentencias for................................................................................................................................15
7.6
Sentencias while............................................................................................................................15
7.7
Sentencias do-while.......................................................................................................................16
7.8
Sentencias switch..........................................................................................................................16
7.9
Sentencias try-catch......................................................................................................................16
8
Espacio en blanco...........................................................................................................17
8.1
Líneas en blanco............................................................................................................................17
8.2
Espacios en blanco........................................................................................................................17
9
Convenciones de nomenclatura.......................................................................................18
10
Hábitos de programación..............................................................................................18
10.1
Proporcionar acceso a variables de instancia y de clase..............................................................18
10.2
Referencias a variables y métodos de clase................................................................................19
10.3
Constantes..................................................................................................................................19
10.4
Asignaciones de variables............................................................................................................19
10.5
Hábitos varios..............................................................................................................................19
10.5.1
Paréntesis............................................................................................................................19
10.5.2
Valores de retorno...............................................................................................................20
10.5.3
Expresiones antes de «?» en el operador condicional..........................................................20
10.5.4
Comentarios especiales.......................................................................................................20
11
Ejemplo de código.........................................................................................................20
11.1
Ejemplo de archivo fuente Java....................................................................................................20
4/22
Convenciones de código para el lenguaje de programación Java
Introducción
1 Introducción
1.1 Por qué convenciones de código
Las convenciones de código son importantes para los programadores por muchas 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 rápidamente y más a fondo.
Si distribuye su código fuente como un producto, necesita asegurarse de que está 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 estándares de codificación del lenguaje Java presentados en «Java
Language Specification»,
de Sun Microsystems, Inc. Los mayores contribuidores son Peter King, Patrick
Naughton, Mike DeMoney, Jonni Kanerva, Kathy Walrath, y Scott Hommel. Este documento es mantenido
por Scott Hommel. Envíe sus 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 web de fomentar el uso y
conocimiento del lenguaje Java dentro del mundo hispanoparlante. 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.
Este
documento
ha
sido
revisado
y
corregido
en
marzo
de
2007
por
Lucas
Vieites
(www.codexion.com) .
2 Nombres de archivo
Esta sección enumera las extensiones y los nombres de archivo más usados .
2.1 Extensiones de los archivos
El software Java usa las siguientes extensiones para sus archivos:
5/22

Plik z chomika:

Inne pliki z tego folderu:

Inne foldery tego chomika:

Zgłoś jeśli naruszono regulamin