Documentacion

Módulo 1

Programación Java
Clase 1
• Repaso Java • Estándares de codificación Java • Buenas prácticas

Alejandro González Orellana

Temario
• Repaso Java • Estándares de codificación Java• Buenas prácticas

Temario
• Repaso Java • Estándares de codificación Java • Buenas prácticas

Estándares de codificación Java
Normas básicas
• Evitar archivos de más de 2000 líneas •Estructura de un archivo:  Comentario inicial  Declaración de package  Declaración de imports  Doc-comment de la clase o interfaz  Implementación • Simple utilizar packages • Utilizar imports explícitosEstándares dede codificación Java Estándares codificación Java
/* * CustomerData.java * * Last Modification * Author: Agonzalez * Date: 08-jun-2005 * * JaNoX Software Inc. */
Comentario inicial,puede incluir datos de la última modificación, empresa, etc.

package org.janox.customers.data; import java.util.Map; import java.util.HashMap

Siempre utilizar packages

Evitar imports deltipo java.util.*

/** * Represents the basic data of a customer Doc-comment, aparecerá * en el Javadoc de la clase * @author Agonzalez * */ public class CustomerData {

Estándares de codificaciónJava
Indentación
• Evitar líneas de más de 80 caracteres de largo, son incompatibles con algunas herramientas. Si una línea es muy larga dividirla • Se utilizan cuatro espacios como unidad deindentación

Estándares de codificación Java
Nomenclatura de nombres
• Nombres de paquete: Completamente en minúsculas, el nombre debe seguir el estandar. Ej: com.janox.customers,com.janox.customers.data • Nombres de clase e interfaces: La primera letra de cada palabra debe ser mayúscula. Ej: Item, CustomerData • Nombres de métodos y variables: La primera palabra en minúsculas, y el resto comenzandoen mayúsculas. Ej: addItem(), itemNumber, setName(), getName() • Nombres de constantes: Deben estar completamente en mayúsuculas, las palabras se separan con _ (underscore). Ej: MAX_ITEM_NUMBER,...