Organización de Ficheros
Un fichero consta de 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 aburridos y deberían evitarse.
Puedes ver un ejemplo de un programa Java apropiadamente formateado, en la página
Ejemplo de Fichero Fuente Java.
Ficheros Fuente Java
Todo fichero fuente Java contiene una sóla clase pública o un interface. Cuando hay clases
privadas e interfaces asociados con una clase pública, se pueden poner dentro del mismo
fichero fuente que la clase pública. La clase pública debería ser la primera clase o interface
en el fichero. Los fichero fuente Java tienen el siguiente orden:
- Comentarios de inicio
- Sentencias Package e Import
- Declaraciones de clase e interface.
Comentarios de Inicio
Todos los ficheros fuente deberían empezar con un comentario al estilo-C que liste el nombre
de la clase, la información de versión, la fecha y las notas de copyright:
/*
* Classname
*
* Version information
*
* Date
*
* Copyright notice
*/
Sentencias Package e Import
La primera línea no cometnada de la mayoría de los ficheros fuente Java es una sentencia
package. Después de esta pueden seguir sentencias
import. Por ejemplo:
package java.awt;
import java.awt.peer.CanvasPeer;
Declaraciones de Clase e Interface
La siguiente tabla describe las partes de una declaración de clase o interface, en el orden
en que deberían aparecer. Puedes ver un ejemplo commentado en la página
Ejemplo de Fichero Fuente Java:
| |
Parte de la clase/Interface |
Notas |
| 1 |
Comentario de documentación de Clase/interface (/**...*/) |
Ver la sección Comentarios de
Documentación |
| 2 |
Sentencia class o interface |
|
| 3 |
Comentario de implemetnación de Clase/interface (/*...*/), si es necesario |
Este comentario debería contener cualquier información sobre la clase o el interface que
no fuera apropiada para ponerla en el comentario de documentación. |
| 4 |
Variables de clase (static) |
Primero las variables de clase pública, luego las protegidas, después las de nivel de
paquete (sin modificador de acceso), y por último las privadas. |
| 5 |
Variables de Ejemplar |
Primero las variables de clase pública, luego las protegidas, después las de nivel de
paquete (sin modificador de acceso), y por último las privadas. |
| 6 |
Constructores |
|
| 7 |
Métodos |
Estos métodos deberían agruparse por funcionalidad en vez de por ámbito o accesibilidad.
Por ejemplo, un método de clase privado puede ir entre dos métodos de ejemplar públicos.
El objetivo es hacer la lectura y el entendimiento del código más fácil. |
Tutoriales
