INSTITUTO SUPERIOR TECNICO MAYOR PEDRO TRAVERSARI
NOMBRE: JONATHAN PAREDES
TEMA: ESTANDARES DE PROGRAMACION DE JAVA
INTRODUCCIÓN
El establecimiento de los estándares o convenciones de programación empleados en el
desarrollo de software sobre la 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.
Organización de ficheros
Las clases 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. Por
ejemplo, 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 que contengan 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.
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 el nombre 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.
• Declaraciones de clases e interfaces.
Comentarios de inicio
Todo fichero fuente debe comenzar con un comentario que incluya el nombre de la
clase, información sobre la versión del código, la fecha y el copyright. El copyright indica la
propiedad legal del código, el ámbito de distribución, el uso para el que fue desarrollado y su
modificación.
Dentro de estos comentarios iniciales podrían incluirse adicionalmente comentarios
sobre los cambios efectuados sobre dicho fichero (mejora, incidencia, error, etc.). Estos
comentarios son opcionales si los ficheros están bajo un sistema de control de versiones bien
documentado, en caso contrario se recomienda su uso. Estos comentarios constituyen el
historial de cambios del fichero. Este historial es único para cada fichero y permitirá conocer
rápidamente el estado y la evolución que ha tenido el fichero desde su origen.
Sentencias de paquete
La primera línea no comentada de un fichero fuente debe ser la sentencia de paquete,
que indica el paquete al que pertenece(n) la(s) clase(s) incluida(s) en el fichero fuente. Por
ejemplo,
PACKAGE JAVAX.CRYPTO;
Sentencias de importación
Tras la declaración del paquete se incluirán las sentencias de importación de los
paquetes necesarios. Esta importación de paquetes obligatorios seguirá el siguiente orden:
Paquetes del JDK de java.
Paquetes de utilidades no pertenecientes al JDK de Java, de frameworks de desarrollo
o de proyectos opensource tales como apache, hibernate, springframework, etc.
Paquetes desarrollados para el Ayuntamiento de Málaga.
Paquetes de la aplicación.
Se recomienda minimizar en la medida de lo posible el uso de importaciones del tipo
"package.*", pues dificultan la comprensión de las dependencias existentes entre las clases
utilizadas por la aplicación. En caso contrario, se recomienda utilizar comentarios de línea tras
la importación.
Métodos
Deben agruparse por funcionalidad en lugar de agruparse por ámbito o accesibilidad.
Por ejemplo, un método privado puede estar situado entre dos métodos públicos. El objetivo
es desarrollar código fácil de leer y comprender.
Sangría
Como norma general se establecen 4 caracteres como unidad de sangría. Los entornos
de desarrollo integrado (IDE) más populares, tales como Eclipse o NetBeans, incluyen
facilidades para formatear código Java.
Longitud de línea
La longitud de línea no debe superar los 80 caracteres por motivos de visualización e
impresión.
División de líneas
Cuando una expresión ocupe más de una línea, esta se podrá romper o dividir en función
de los siguientes criterios:
• Tras una coma.
• Antes de un operador.
Se recomienda las rupturas de nivel superior a las de nivel inferior.
Alinear la nueva línea con el inicio de la expresión al mismo nivel que la línea anterior.
Si las reglas anteriores generan código poco comprensible, entonces estableceremos
tabulaciones de 8 espacios.
Comentarios
Distinguimos dos tipos de comentarios: los comentarios de implementación y los de
documentación.
Comentarios de implementación
Estos comentarios se utilizan para describir el código ("el cómo"), y en ellos se incluye
información relacionada con la implementación, tales como descripción de la función de
variables locales, fases lógicas de ejecución de un método, captura de excepciones, etc.
Distinguimos tres tipos de comentarios de implementación:
Comentarios de bloque:
Permiten la descripción de ficheros, clases, bloques, estructuras de datos y algoritmos.
/*
* Esto es un comentario
* de bloque
*/
Comentarios de línea:
Son comentarios cortos localizados en una sola línea y tabulados al mismo nivel que el
código que describen. Si ocupa más de una línea se utilizará un comentario de bloque. Deben
estar precedidos por una línea en blanco.
/* Esto es un comentario de línea */
// Esto es otro comentario de línea
Comentario a final de línea
Comentario situado al final de una sentencia de código y en la misma línea.
int contador = 4 + 10; // Inicialización del contador
contador++; /* Incrementamos el contador */
Comentarios de documentación
Los comentarios de documentación, también denominados "comentarios javadoc", se
utilizan para describir la especificación del código, desde un punto de vista independiente de
la implementación, de forma que pueda ser consultada por desarrolladores que probablemente
no tengan acceso al código fuente.
Declaraciones
Una declaración por línea
Se recomienda el uso de una declaración por línea, promoviendo así el uso de
comentarios. Ejemplo,
int idUnidad; // Identificador de la unidad organizativa
String[] funciones; // Funciones de la unidad
Inicialización
Toda variable local tendrá que ser inicializada en el momento de su declaración, salvo
que su valor inicial dependa de algún valor que tenga que ser calculado previamente.
int idUnidad = 1;
String[] funciones = { "Administración", "Intervención", "Gestión" };
Localización
Las declaraciones deben situarse al principio de cada bloque principal en el que se
utilicen, y nunca en el momento de su uso.
public void unMetodo() {
int contador = 0; // inicio del método
La única excepción a esta regla son los índices de los bucles "for", ya que, en Java, pueden
incluirse dentro de la propia sentencia "for".
for (int i=0; contador<10; i++) {
}
Se debe evitar el uso de declaraciones que oculten a otras declaraciones de ámbito superior.
int contador = 0; // Inicio del método
public void unMetodo() {
if (condicion) {
int contador = 2; // ¡¡ EVITAR !!
Declaración de clases / interfaces
Durante el desarrollo de clases / interfaces se deben seguir las siguientes reglas de
formateo:
No incluir ningún espacio entre el nombre del método y el paréntesis inicial del listado de
parámetros.
El carácter inicio de bloque ("{") debe aparecer al final de la línea que contiene la sentencia de
declaración.
El carácter fin de bloque ("}") se sitúa en una nueva línea tabulada al mismo nivel que su
correspondiente sentencia de inicio de bloque, excepto cuando la sentencia sea nula, en tal caso
se situará detrás de "{".
Los métodos se separarán entre sí mediante una línea en blanco.
public classe ClaseEjemplo extends Object {
int variable1;
int variable2;
public ClaseEjemplo() {
variable1 = 0;
variable2 = 1;
CONCLUSIONES
En el desarrollo de esta investigación estamos viendo cada paso y teoría de como inicializar un
programa o proyecto, con las referencias que debe llevar el mismo, se las puede mencionar
como instrucciones.
WEBGRAFIA
https://www.academia.edu/34544928/MEMORIA_DEL_PROYECTO_INTEGRADOR_Proyecto_Sistematizaci%C3
%B3n_de_los_procesos_de_n%C3%B3mina_mediante_un_aplicativo_web
