CHEQUEO DE ESTILO (CHECKSTYLE)

Checkstyle es una herramienta diseņada para que los programas cumplan con ciertos estandares de estilo.

La idea principal del chequeo de estilo es estandarizar los codigos escritos en ciertos lenguajes para que cumplan con normas, las cuales tienen por objeto facilitar la lectura y el trabajo de terceros.

El sistema es el siguiente: Se descarga un programa en .JAR desde la pagina oficial. Para luego descargar el chequeo de estilo que necesites, existen distintos tipos de chequeo. El que utilizaremos nosotros es el sjsu.xml. Y luego se ocupa el programa para aplicar el archivo xml al codigo que queramos chequear y listo. El programa nos dira si cumple o no la norma, y los posibles errores encontrados.

A continuacion se presenta un procedimiento mas minucioso de como realizar el chequeo.

PROCEDIMIENTO desde ARAGORN:

  1. El programa (checkstyle 3.5) ya esta instalado en aragorn, por lo que no debes descargarlo.
    El directorio del programa en aragorn es: /usr/local/checkstyle/
    Y el programa a utilizar es: checkstyle-all-3.5.jar
    Ademas, en ese directorio se ecnuentran otras utilidades y mas informacion sobre como utilizar el programa con opicones mas avanzadas, me remito a explicar la informacion basica.

  2. Luego debes bajar el archivo con el chequeo de estilo, en nuestro caso el sjsu.xml, desde esta direccion: sjsu.xml

  3. Finalmente, se ejecuta el programa con el siguiente formato:

    java -jar /path del programa/checkstyle-all-3.5.jar -c
    /path del archivo de estilo/archivo.xml   /path de tu archivo/archivo.java

    Los path deben ser con respecto a la raiz de aragorn. Para nuestro caso, uds debieran hacer algo como:

    java -jar /usr/local/checkstyle/checkstyle-all-3.5.jar -c
    /home/alm2002/cvasquez/sjsu.xml   /home/alm2002/cvasquez/TU_CODIGO.java

Pueden ver el path de su cuenta en aragorn con el comando:
cvasquez@aragorn:~ pwd

Si deseas probar el chequeo de estilo desde tu casa, debes descargar el programa desde la pagina oficial en: http://checkstyle.sourceforge.net/

Espero que esta informacion les sirva de ayuda, y cualquier duda o consulta, enviar un mail al ayudante actual del ramo.



Cesar Vasquez Ibaceta.
16 de Abril de 2005.