Lineamientos Generales

Anterior | Inicio | Siguiente

Identacion de código

Se deben usar 4 espacios como unidad de identación, no se permiten tabuladores (el estándar de Sun no prohíbe el uso de tabuladores, sin embargo, la combinación de espacios y tabuladores puede generar inconsistencias en la presentación en otros editores), se debe configurar el editor para que inserte cuatro espacios en lugar de tabulador al presionar la tecla. En eclipse la configuración se hace por la opción Window > Preferences

Evitar líneas mayores a 80 caracteres, cuando la línea sea muy larga, partirla de acuerdo a los siguientes principios:

  • Partirla después de una coma
  • Partirla antes de un operador
  • Alinear la siguiente línea con el inicio de la expresión que está en el mismo nivel en la línea anterior
  • Si la regla anterior hace el código muy confuso, utilizar para las siguientes líneas identación de 8 espacios.

Utilizar el estilo sugerido por Sun con las llaves en la misma línea de la instrucción que inicia el bloque: La información se puede complementar en la siguiente URL: http://java.sun.com/docs/codeconv/html/CodeConventions.doc7.html#475

Comentarios y Javadoc

1. Las Clases, Métodos y Atributos Públicos deben llevar comentarios JavaDoc.
Cuando las descripciones sean extensas y se requiera estructurar el texto, utilizar los tags HTML:

  • <p></p> o <br/> para organizar el texto en párrafos.
  • <b></b> para resaltar en negrilla.
  • <u></u> para subrayar.
  • <ul><li></li><li></li>…</ul> para viñetas u <ol></ol> para enumerar.

Adicionalmente tags de formato propios de JavaDoc como:
<code></code> para incluir en los comentarios palabras reservadas, nombres de clases, métodos, atributos o paquetes.

2. Para los comentarios descriptivos o que explican el flujo de la programación de la clase, se utilizarán bloques /* */, para comentarios temporales (por ejemplo código comentado) se utilizará // Para quitar comentarios se selecciona el bloque y se presiona Ctrl+7 en eclipse.
Para información más completa:
http://java.sun.com/j2se/javadoc/writingdoccomments/

3. Se debe utilizar Tags de JavaDoc para mostrar información de las clases y sus métodos

  • Tags a nivel de clase

@author: (obligatorio). Se debe colocar el nombre y correo electrónico de la siguiente forma:
Germán Quiñones <moc.liame|senoniuqg#moc.liame|senoniuqg>

@version Versión de la clase (no es obligatorio).

@see Referencias a otras clases, que se debe indicar incluyendo el paquete, cuando se trate de métodos que pertenecen a la clase se coloca: com.paquete.NombreClase#nombreMetodo

Para automatizar este comentario, se utiliza la plantilla de eclipse que se accede en las preferencias de eclipse, y luego las opciones Java > Editor > Templates

  • Tags JavaDoc en Métodos

Los comentarios JavaDoc para los métodos no incluyen el tag @author, como parte de la descripción se debe colocar el autor en los casos en que difiera del autor de la clase.

@param (múltiple) Se debe indicar después del tag el nombre del parámetro y enseguida la descripción, es importante que la descripción sea útil proporcionando información sobre restricciones, valores aceptados, etc.

@return Después del Tag se coloca la descripción de la variable de salida. Como parte de la descripción, indicar el tipo de dato retornado (JavaDoc no indica el tipo de dato de las variables de retorno).

@exception (múltiple) Excepciones que puede generar el método.

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License