Mejora de la calidad del código fuente con Eclipse

0
17313

Mejora de la calidad del código fuente con Eclipse

Introducción

En mi experiencia como programador he tenido que desarrollar tanto aplicaciones desde cero así como continuar con desarrollos de otras personas.

Aunque una aplicación funcione perfectamente, el esfuerzo de mantenimiento de una aplicación puede ser más costoso en tiempo (lo que implica dinero) que rehacer la aplicación en su totalidad. Este esfuerzo está directamente relaccionado con varios factores, uno de ellos es la claridad y formato del código fuente.

En este pequeño tutorial os muestro una de esas multiples opciones de la plataforma de desarrollo Eclipse que muchos de nosotros no vemos y que nos hubieran ahorrado un gran esfuerzo si lo hubieramos conocido en su dia.

Para presentar esta característica de Eclipse vamos a basarnos en el siguiente ejemplo:

Código fuente del ejemplo

Observe el siguiente código fuente. Si observa el código, este funciona, pero no cumple varios de los convenios establecidos.

Yo personalmente observo los siguientes defectos más relevantes (Aunque se que pueden ser discutibles):

  1. Se importa una clase que no es utilizada.
  2. Los atributos de clase e instancia no tienen cualificador de visibilidad (public, private, etc)
  3. El atributo ec no se usa.
  4. En el constructor hay un cast innecesario
  5. El acceso a los atributos no tiene el cualificador de acceso necesarios: (this.XXX o clase.XXX)
  6. Las sentencias condicionales no tienen llaves de apertura y cierre, lo que puede crear confusiones si se habre el código con otro editor.
  7. Las tabulaciones no son correctas.

 

Ahora imagine que el proyecto tiene 400 clases, todas con estas u otras deficiencias.

¿Muchas deficiencias para solventar a mano, verdad ?

Pues nada, aquí entra Eclipse (A partir de la versión 3.2), para hacernos de nuevo la vida más facil.

Seleccionamos la clase que deseamos corregir (Incluso el paquete o proyecto entero), sacamos el menu contextual con el botón derecho del ratón, y nos vamos a la opción Source y luego seleccionamos la opción Clean up.

En este momento Eclipse nos mostrará un cuadro de diálogo donde eligiremos las correcciones que deseamos hacer.

Imagen1

Las seleccionamos y pulsamos aceptar. Entonces Eclipse nos mostrará una ventana dividida en dos partes, en la parte izquierda nos muestra el código fuente actual y en la derecha el código fuente modificado aplicando los parámetros que especificamos.

Imagen2

Aceptamos aquellos cambios que estimemos oportunos y Eclipse hará el resto.

Nota: Para corregir los errores de tabulaciones debe seleccionar otra de las opciones de Eclipse: Source->Correct Indentacion

Conclusiones

Desde mi punto de vista hay que hacer las cosas bien desde el primer momento, el código debe ser fácilmente comprensible pues reducirá mucho costes de aprendizaje y mantenimiento… yo particularmente soy un fanático de las cosas bien hechas,
y bueno, a veces estas herramientas te ayudan a poner orden en los códigos que heredas o tienes que mantener.

Bueno, espero que os haya sido de utilidad este tutorial, para terminar os recomiendo la lectura del siguiente tutorial: Crap4j, ¿es tu código difícilmente mantenible?

Un saludo. Carlos García.

Dejar respuesta

Please enter your comment!
Please enter your name here