integrales aplicacion

Estándares de Codificación Java
Propósito

Guiar en la implementación de programas con los Estándares de
Codificación Java.
Documentación Se aconseja, como buena práctica de programación, incluir en la entrega
JavaDoc
de la aplicación la documentación de los ficheros fuente de todas las
clases. Dicha documentación será generada por la herramienta
"javadoc". La herramienta "javadoc"construirá la documentación a
partir de los comentarios (incluidos en las clases) encerrados entre los
caracteres
"/**"
y
"*/"
@author Nombre - Añade información sobre el autor o autores del
código
@version InformacionVersion - Permite incluir información sobre la
versión
y
fecha del código.
@param NombreParametro Descripción - Inserta el parámetro
especificado y su descripción en lasección "Parameters:" de la
documentación del método en el que se incluya
@return Descripción - Inserta la descripción indicada en la sección
"Returns:" de la documentación del método.
@throws NombreClase Descripción - Añade el bloque de comentario
"Throws:" incluyendo el nombre y la descripción de la excepción
especificada.
@see Referencia - Permite incluir en la documentación la sección decomentario "See also:", conteniendo la referencia indicada.
@deprecated Explicación - Esta etiqueta indica que la clase, interfaz,
método o campo está obsoleto y que no debe utilizarse, y que dicho
elemento posiblemente desaparecerá en futuras versiones. ".
@since Version - Se utiliza para especificar cuándo se ha añadido a la
API la clase, interfaz, método o campo. Debería incluirse el númerode
versión u otro tipo de información.
Encabezado del
Comience todos los programas con una cabecera descriptiva.
Programa
Formato de la
/*
cabecera
* @(#)Discapacidad.java 1.50 04/04/12
Estándar
*
Codificación
* Copyright 2004 Sun Microsystems, Inc. All rights reserved.
Java
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license
terms.
*/
/**
* Esta clase implementa los métodosnecesarios para poder utilizar los
métodos
* necesarios en el manejo del registro de

discapacidades.
* @author Angel Yánez
* @version 1.50, 04/14/12
* @since 1.4
*/
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 dedistribució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.).
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)
incluída(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:
1. Paquetes del JDK de java.
2. Paquetes de utilidades no pertenecientes al JDK de Java, de
frameworks dedesarrollo o de proyectos opensource tales como apache, hibernate,
springframework, etc.
3. Paquetes de la aplicación.

Declaraciones
de clases e
interfaces

Comentario de documentación de la clase/interfaz /** ... */ - Permite
describir la clase/interfaz desarrollada. Necesario para generar la
documentación de la api mediante javadoc.
Comentario de implementación de la clase/interfaz, sies necesario /*
... */ - Este comentario incluye cualquier información que no pueda
incluirse en el comentario de documentación de la clase/interfaz.
Variables de clase (estáticas) - En primer lugar las variables de clase
públicas (public), después las protegidas (protected), posteriormente las
de nivel de paquete (sin modificador), y por último las privadas
(private).
Variables de...