Eclipse y estándares de código

Si sueles trabajar en equipo a la hora de programar, e incluso si no es el caso, puede ser interesante establecer unos estándares a seguir a la hora de escribir el código. Para asegurarnos de que estas reglas se siguen se puede utilizar, por ejemplo, Checkstyle, que se integra en Eclipse a través del plugin del mismo nombre.

La forma más sencilla de instalar este plugin es utilizar el sistema de actualizaciones de software de Eclipse. En el diálogo Help -> Software updates -> Available Software -> Add Site introducimos la URL desde la que instalar el plugin, “http://eclipse-cs.sourceforge.net/update”, marcamos nuestra nueva fuente y seleccionamos Install.

Si entramos ahora en Window -> Preferences ->Checkstyle veremos las opciones de configuración relativas a Checkstyle. Como vemos en Global Check Configurations, Checkstyle utiliza por defecto las convenciones de la guía de estilo de Sun (Sun Checks), pero podemos editarlas o crear un nuevo conjunto de reglas fácilmente. El plugin también incluye un conjunto de normas basadas en las convenciones de Sun, ligeramente modificadas para adaptarse mejor a la configuración por defecto del formateador de código de Eclipse: Sun Checks (Eclipse).

Para activar Checkstyle para uno de nuestros proyectos haremos clic con el botón derecho sobre él, seleccionaremos Properties y en la sección dedicada a Checkstyle marcaremos Checkstyle active for this project. En esta sección podemos seleccionar también el conjunto de normas que nuestro proyecto debe de seguir, asi como posibles excepciones.

Una vez activado Checkstyle para el proyecto veremos los Warnings relativos a los estándares de código en la vista Problems, así como en el propio editor, donde las advertencias se muestran con fondo amarillo. También podemos recurrir a la vista Checkstyle violations (Window -> Show view -> Checkstyle -> Checkstyle violations), que está más especializada y permite agrupar los problemas, generar informes en formato rtf, y lanzar la vista Checkstyle violations chart, con un gráfico de tarta con los distintos problemas encontrados en el código.

Comentarios
  1. Y para equipos a lo nazi siempre podremos usar los hooks pre-commit y así si que te aseguras que todo está como debe de estar.

    Responder

  2. @Blaxter yo lo usaba hasta hace tiempo en un pequeño hook en Python pero integrado en Eclipse es mucho más cómodo y rápido de usar. 🙂

    Si no te fías supongo que lo suyo sería tener los dos, si 😛

    Responder

  3. Anónimo

    En mi empresa yo utilizo el módulo “bronca porque es la enésima vez que te aviso y me tienes hasta los cojones” con el plugin “lo reescribes siguiendo las normas fuera de tus horas de trabajo” ;).

    Responder

  4. Muy interesante si usas Eclipse. Sabes si existe algo parecido para PHP u otros lenguajes? Algun lugar para poder leer “buenas maneras” de programar?
    Gracias 😀

    P.D. El editor que uso es TextMate para OSX

    Responder

  5. @Zootropo me lo miraré con tranquilidad luego, gracias. Así a priori, como dices, parece un poco muerto.

    Responder

  6. En mi empresa.. hemos establecido unos patrones de diseño. Al principio nos costaba pero ya nos hemos aconstumbrado a seguirlo.. y las nomenclaturas las seguimos al dedillo…. eso si ya la forma de programar de cada uno no la cambia nadie :p

    Responder

  7. La táctica de Anónimo es muy tremenda, hay que reconocerlo.

    Responder

  8. […] IDE y sus plugins, como Configurar Eclipse, Decompilar clases Java, Mejora tu código Java con PMD, Eclipse y estándares de código o Subclipse: plugin de Subversion para […]

    Responder

  9. […] IDE y sus plugins, como Configurar Eclipse, Decompilar clases Java, Mejora tu código Java con PMD, Eclipse y estándares de código o Subclipse: plugin de Subversion para […]

    Responder

Deja un comentario