Convenciones de codigo

Publicado en jpereza (http://jpereza.nom.es) Creado 10/01/2008 - 17:39 Por jpereza Java

Convenciones de Código Java
Traducción del artículo original de Sun Microsystems, Inc. Code Conventions for the JavaTM Programming Language [1].

Por qué tener convenciones de código
Las convenciones de código son importantes para los programadores por numerosas razones: El 80% del tiempo de vida de unprograma se dedica al mantenimiento del mismo. En pocas ocasiones, el programa es mantenido durante toda su vida útil por su autor original. Las convenciones de código aumentan la legibilidad de los programas, permitiendo a los desarrolladores comprender nuevo código rápida y perfectamente. Si se distribuye el código fuente como un producto, se necesita asegurar que está tan bien empaquetado ylimpio como cualquier otro producto que se cree.

Reconocimientos
Este documento refleja los estándares de codificación del lenguaje Java presentados en la Especificación del Lenguaje Java [2], de Sun Microsystems, Inc. Sus principales contribuciones son de Peter King, Patrick Naughton, Mike DeMoney, Jonni Kanerva, Kathy Walrath y Scott Hommel. Cualquier comentario sobre el documento original (eninglés) debería ser enviado a Sun Microsystems, Inc. a través del siguiente formulario de contacto [3]. Cualquier comentario sobre esta traducción debería ser enviado a Jesús Pérez Alcaide [4].

Nombres de fichero
Esta sección lista los nombres de fichero y sufijos usados comúnmente.

Sufijos de fichero
Java utiliza los siguientes sufijos de fichero: Tipo de fichero Código fuente Java Sufijo .javaCódigo compilado Java .class

Nombres de ficheros comunes
Nombre de fichero LEEME Uso Nombre preferido para el fichero que resume el contenido de un directorio en particular.

Organización de ficheros
Un fichero consiste en secciones que deberían estar separadas por líneas en blanco y un comentario opcional identificando cada sección. Los ficheros de más de 2000 líneas son demasiado largos y deberíanevitarse. Para ver un ejemplo de un programa Java correctamente formado, ir al Ejemplo de código fuente Java [5].

Ficheros de código fuente Java
Cada fichero de código fuente Java contiene una única clase o interfaz público. Cuando una clase pública tiene clases privadas e interfaces asociados, se pueden poner en el mismo fichero de código fuente que la clase pública. La clase pública deberíaser la primera clase o interfaz en el fichero. Los ficheros de código fuente Java tienen la siguiente ordenación: Comentarios iniciales Sentencias package e import Declaraciones de clase e interfaz Comentarios iniciales Todos los ficheros de código fuente deberían comenzar con un comentario que muestre el nombre de la clase, información sobre la versión, la fecha y el copyright.
/* * Nombre de laclase * * Información sobre la versión * * Fecha * * Copyright */

Sentencias package e import La primera línea que no sea un comentario de todos los ficheros de código fuente Java es una

sentencia package. Después, puede haber sentencias import. Por ejemplo:
package es.nom.jpereza; import java.util.List;

Nota: El primer componente de un nombre de paquete único estaría siempre escrito enletras ASCII minúsculas y sería uno de los nombres de dominio de nivel superior (actualmente com, edu, gov, mil, net, org ó uno de los códigos de país de dos letras, como se especifica en el estándar ISO 3166 [6]). Declaraciones de clase e interfaz La siguiente tabla describe las partes de una declaración de clase o interfaz, en el orden que deben aparecer. En Ejemplo de código fuente Java [5] hay unejemplo que incluye comentarios. Parte de la declaración de Clase/Interfaz Comentario de documentación 1 de la clase/interfaz
(/** ... */)

Notas Ver Comentarios [7] para más información sobre el contenido de este comentario.

2 Sentencia class ó interface Comentario de la implementación de la 3 clase/interfaz, si fuera necesario
(/* ... */)

Este comentario debería contener cualquier...