ESTANDARESDECODIFICACIONJAVA




MANUEL GÒMEZ-LOBO ROMERO PRIMERO DESARROLLO DE SOFTWARE NOCTURNO

Java - Estándares de programación


Índice

1. Estándares de programación
1.1. Introducción
1.2. Organización de ficheros
1.2.1. Fichero fuente Java (.java)
1.2.1.1. Comentarios de inicio
1.2.1.2. Sentencias de paquete
1.2.1.3. Sentencias deimportación
1.2.1.4. Declaraciones de clases e interfaces
1.3. Sangría
1.3.1. Longitud de línea
1.3.2. División de líneas
1.4. Comentarios
1.4.1. Comentarios de implementación
1.4.2. Comentarios de documentación
1.5. Declaraciones
1.5.1. Una declaración por línea
1.5.2. Inicialización1.5.3. Localización
1.5.4. Declaración de clases / interfaces
1.6. Sentencias
1.7. Espacios en blanco
1.8. Nomenclatura de identificadores
1.8.1. Paquetes
1.8.2. Clases e interfaces
1.8.3. Métodos
1.8.4. Variables
1.8.5. Constantes
1.9. Prácticas de programación
1.9.1. Visibilidad de atributos de instancia yde clase
1.9.2. Referencias a miembros de una clase
1.9.3. Constantes
1.9.4. Asignación sobre variables
1.9.5. Otras prácticas
2. Documentación: javadoc

1. Estándares de programación

1.1. Introducción

El objeto del presente documento es el establecimiento de los estándares o convenciones de programación empleados en el desarrollo de software sobrela plataforma Java. Este modelo de programación está basado en los estándares recomendados por Sun Microsystems, que han sido difundidos y aceptados ampliamente por toda la comunidad Java, y que han terminado por consolidarse como un modelo estándar de programación de facto.

Estas normas son muy útiles por muchas razones, entre las que destacan:

•Facilitan el mantenimiento de una aplicación.Dicho mantenimiento constituye el 80% del coste del ciclo de vida de la aplicación.

•Permite que cualquier programador entienda y pueda mantener la aplicación. En muy raras ocasiones una misma aplicación es mantenida por su autor original.

•Los estándares de programación mejoran la legibilidad del código, al mismo tiempo que permiten su compresión rápida.



1.2. Organización de ficheros

Lasclases en Java se agrupan en paquetes. Estos paquetes se deben organizar de manera jerárquica, de forma que todo código desarrollado para el Ayuntamiento de Málaga tendrá que estar incluido dentro del paquete "eu.malaga".
Dentro del paquete principal las clases se organizarán en subpaquetes en función del área, organismo o sección del Ayuntamiento al que pertenezca el código desarrollado. Porejemplo, si estamos desarrollando un servicio web de inscripción a un curso de programación Java del IMFE las clases de dicho servicio se incluirían en el paquete "eu.malaga.imfe.webservices.cursojava" o similar.

Un fichero consta de secciones que deben estar separadas por líneas en blanco y comentarios opcionales que identifiquen cada sección.

Deben evitarse los ficheros de gran tamaño quecontengan más de 1000 líneas. En ocasiones, este tamaño excesivo provoca que la clase no encapsule un comportamiento claramente definido, albergando una gran cantidad de métodos que realizan tareas funcional o conceptualmente heterogéneas.

1.2.1. Fichero fuente Java (.java)

Cada fichero fuente Java debe contener una única clase o interfaz pública. El nombre del fichero tiene que coincidir con elnombre de la clase. Cuando existan varias clases privadas asociadas funcionalmente a una clase pública, podrán colocarse en el mismo fichero fuente que la clase pública. La clase pública debe estar situada en primer lugar dentro del fichero fuente.
En todo fichero fuente Java distinguimos las siguientes secciones:

•Comentarios de inicio.

•Sentencia de paquete.

•Sentencias de importación....