miércoles, 23 de enero de 2013

Coffee-bytes: organiza tu código en regiones en Eclipse

Si has programado en .NET y has utilizado el entorno de desarrollo Visual Studio, echarás de menos la organización del código mediante regiones.



(a) Regiones mediante comenterios "gruesos"


(b) Regiones con Coffee-Bytes


Las regiones no son sino una forma de organizar, ordenar el código dentro de un fichero.
Son las zonas, las áreas en las que organizas tu código: arriba del todo los imports, justo al comienzo de la clase sus atributos, después sus getters,...

En la imagen (a) vemos dos regiones, la de imports y la de atributos. En este ejemplo he creado mis regiones (mis áreas del código) simplemente añadiendo líneas gruesas de comentario (con varias líneas de almohadillas).

Al lado, en la imagen (b), muestro todas las regiones, pero ahora sí utilizando un plugin para eclipse que me permite justo eso, crear y manejar mis propias regiones, colapsar el código de una región, abrirlo,...

Esto facilita enormemente la lectura y la limpieza de nuestro código.

Veamos ahora cómo instalar y configurar Coffee-Bytes en Eclipse.



Yo suelo organizar el código en las siguientes zonas y exactamente en este orden, tal y como vimos en la imagen (b):
  • imports
  • Atributos
  • Getters y Setters
  • Constructores
  • Métodos de sobrecarga de object
  • Métodos auxiliares
  • Métodos públicos
  • Métodos de validación de la clase
  • Métodos de acceso a datos
  • Métodos de procedimientos almacenados
Veamos ahora cómo instalar Coffee-Bytes en Eclipse.

1. Descargamos plugin Coffee-Bytes

Puedes encontrar el plugin de aquí.

Descarga el fichero a tu equipo:



2. Carpeta features a la carpeta features de Eclipse

Descomprime el archivo y verás que contiene dos carpetas: features y plugins:


El contenido de la carpeta features, cópialo y pégalo a la carpeta features de tu instalación de Eclipse.



3. Carpeta plugin a la carpeta plugins de Eclipse

Lo mismo con la carpeta plugins: toma todo lo que hay dentro y pégalo tal cual a la carpeta plugins de tu instalación plugins.

4. Reiniciamos Eclipse

Si tenías Eclipse abierto, ciérralo y vuelve a abrirlo.


5. Activar Coffee-Bytes

Entra en el menú Window/Preferences.
Una vez dentro, selecciona Java/ Editor/ Folding.
Selecciona la opción Coffee-Bytes Coffee Folding:






6. Configurar Coffee-Bytes

Desmarca todas las opciones y marca User Defined Regions.
De esta manera crearás tus regiones personalizadas:


Bajo la pestaña User Defined Regions establece que la palabra de inicio de región sea #region y la de cierre de #endregion, más que nada por hacerlo igual que Visual Studio.





6. Listo, ya podemos usarlo y crear nuestras regiones