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. |