Hola

Solo disponible en BuenasTareas
  • Páginas : 13 (3164 palabras )
  • Descarga(s) : 27
  • Publicado : 29 de enero de 2009
Leer documento completo
Vista previa del texto
Organización de ficheros

Un fichero consiste en secciones que deberían estar separadas por líneas en blanco y un comentario opcional identificando cada sección.

Los ficheros de más de 2000 líneas son demasiado largos y deberían evitarse.

Ficheros de código fuente Java

Cada fichero de código fuente Java contiene una única clase o interfaz público. Cuando una clase pública tiene clasesprivadas e interfaces asociados, se pueden poner en el mismo fichero de código fuente que la clase pública. La clase pública debería ser la primera clase o interfaz en el fichero.
Los ficheros de código fuente Java tienen la siguiente ordenación:
• Comentarios iniciales
• Sentencias package e import
• Declaraciones de clase e interfaz

Comentarios iniciales

Todos los ficheros de códigofuente deberían comenzar con un comentario que muestre el nombre de la clase, información sobre la versión, la fecha y el copyright.
/*
* Nombre de la clase
*
* Información sobre la versión
*
* Fecha
*
* Copyright
*/

Sentencias package e import

La primera línea que no sea un comentario de todos los ficheros de código fuente Java es una sentencia package. Después, puedehaber sentencias import.
Nota: El primer componente de un nombre de paquete único estaría siempre escrito en letras ASCII minúsculas y sería uno de los nombres de dominio de nivel superior (actualmente com, edu, gov, mil, net, org ó uno de los códigos de país de dos letras, como se especifica en el estándar ISO 3166).

Declaraciones de clase e interfaz

La siguiente tabla describe las partes deuna declaración de clase o interfaz, en el orden que deben aparecer.
Parte de la declaración de Clase/Interfaz Notas
1 Comentario de documentación de la clase/interfaz
(/** ... */) Ver Comentarios para más información sobre el contenido de este comentario.
2 Sentencia class ó interface
3 Comentario de la implementación de la clase/interfaz, si fuera necesario
(/* ... */) Este comentariodebería contener cualquier información relativa a toda la clase o interfaz, que no sea apropiada para el comentario de documentación.
4 Variables de clase (estáticas)
(static) Primero las variables públicas (public), luego las protegidas (protected), después las de paquete (sin modificador de acceso) y por último las privadas (private).
5 Variables de instancia Primero las variables públicas(public), luego las protegidas (protected), después las de paquete (sin modificador de acceso) y por último las privadas (private).
6 Constructores
7 Métodos Estos métodos deberían estar agrupados por funcionalidad en lugar de por ámbito o accesibilidad. Por ejemplo, un método estático privado puede estar entre dos métodos de instancia públicos.
El objetivo es hacer la lectura y comprensión delcódigo más fácil.



Tabulación

La unidad de tabulación deberían ser cuatro espacios. La forma exacta de la tabulación (espacios ó tabuladores) no se especifica.
Longitud de línea
Evitar las líneas de más de 80 caracteres, ya que algunas herramientas no las manejan bien.
Nota: Ejemplos para uso en documentación deberían tener una longitud de línea menor, generalmente no más de 70caracteres.
Ruptura de líneas (Wrapping lines)
Cuando una expresión no cabe en una única línea, se debe romper de acuerdo a estos principios generales:
• Romper después de una coma.
• Romper antes de un operador.
• Preferir las rupturas de alto nivel a las de bajo nivel.
• Alinear la nueva línea con el principio de la expresión al mismo nivel que la línea anterior.
• Si las reglas anterioresllevan a un código confuso o demasiado pegado al margen derecho, entonces tabular sólo con 8 espacios.
// TABULACION CONVENCIONAL
someMethod(int anArg, Object anotherArg, String yetAnotherArg,
Object andStillAnother) {
...
}

// USAR 8 ESPACIOS PARA EVITAR PEGARSE AL MARGEN DERECHO
private static synchronized horkingLongMethodName(int anArg,
Object anotherArg,...
tracking img