4 Desa Apli Manejo Archivos Capitulo 4 03 Presentacion Javadoc Conveciones

• Temas: JavaDoc y Convenciones
de estilo
•
•
•
•

Covenciones y documentación
Ejemplo
Clase Car
Convenciones de JavaDoc y criterios de estilo

Administración de Proyectos de desarrollo de Software
Ciclode
deaplicaciones
vida de uncon
proyecto
• IV. Desarrollo
manejo de archivos de
texto y de excepciones
JAVA
Enfoqueenmoderno

IV. Desarrollo de aplicaciones con manejo de archivos
de texto y deexcepciones en JAVA

Referencias para documentación Java
•

La documentación que especifica cómo incluir los comentarios de
javadoc la puedes encontrar en:
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
•

Las convenciones de estilo de java las encuentras en:
http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html

Fin de la presentación
Continúe en la siguiente actividadAdministración de Proyectos de desarrollo de Software
Ciclode
deaplicaciones
vida de uncon
proyecto
• IV. Desarrollo
manejo de archivos de
texto y de excepciones
JAVA
Enfoqueenmoderno

IV. Desarrollo de aplicaciones con manejo de archivos
de texto y de excepciones en JAVA

Convenciones y documentación.
• Seguir la convención para nombrar Clases: Primera letra
mayúscula y cada palabra seguidainiciando con mayúscula.MiClaseEsLaMejor
• Cada variable se declara en una sóla línea. El nombre de la
variable debe ser representativo, ej. Usar vector1 en vez de v.
• Después del tipo de dato se usa tabulador
int
uno;
String dos;
Objeto tres;

IV. Desarrollo de aplicaciones con manejo de archivos
de texto y de excepciones en JAVA

Convenciones y documentación.
•

La indentación es debe ser correcta, laclase va en el primer nivel,
las variables y clases se definen en un nivel más adentro:

public class Clase {
public Clase () {
}
public void metodo() {
}
}

•
•

Las llaves abiertas van en la misma linea del estatuto, las llaves
cerradas van a la altura del estatuto que cierran.
Un estatuto por línea.

IV. Desarrollo de aplicaciones con manejo de archivos
de texto y de excepciones en JAVAConvenciones y documentación.

• Formato del if:
if (condición) {    
estatutos;
} else {
estatutos;
}

• Debe haber un espacio entre las palabras reservadas y
el paréntesis.
INCORRECTO: while(
CORRECTO: while (

IV. Desarrollo de aplicaciones con manejo de archivos
de texto y de excepciones en JAVA

Convenciones y documentación.
•

Linea en blanco entre métodos, después de los encabezados demétodos, entre las variables y el primer estatuto del método. Línea
en blanco antes del return.
public void espera() {
int i;
for (i = 0; i < 1000; i++) ;
return true;
}

IV. Desarrollo de aplicaciones con manejo de archivos
de texto y de excepciones en JAVA

Convenciones. (Cont)
•

Espacios en blanco: después de las comas de parámetros, entre cada operador (exceptuando
el punto, ++, --), después de lospunto y comas del for, entre una palabra clave (keyword) y el
paréntesis. Ejemplo:
public double sumaCuadrados(double a, double b) {
double acum = 0.0;
if (math.abs(b) > 0) {
for (int i = 0; i < a; i++) {
acum += math.pow(b, 2);
}
}

 
return acum;
}

IV. Desarrollo de aplicaciones con manejo de archivos
de texto y de excepciones en JAVA

Documentación

IV. Desarrollo de aplicaciones con manejode archivos
de texto y de excepciones en JAVA

Documentación.
Línea de espacio
• Lo primero en la clase son los paquetes.
• Después de una línea en blanco se ponen los imports.
• Después de los imports va una linea en blanco.
• La clase está documentada.
/**
* Descripción
*
* @author Nombre
* @version NumeroVersion
*/
public class MiClase {
}

IV. Desarrollo de aplicaciones con manejo dearchivos
de texto y de excepciones en JAVA

Documentación (Cont)
• Después de cada método hay una línea en blanco.
• Cada método viene comentado según el siguiente formato:
/**
* Descripción
*
* @param parámetro descripción
* @throws nombreExcepción
* @return descripción
*/
• Los elementos a resaltar como tipo de dato están entre etiquetas


IV. Desarrollo de aplicaciones con manejo de...