April 05 Prof. Ismael H. F. Santos - [email protected] 1 Modulo II CheckStyle Professor Ismael H F Santos – [email protected]@tecgraf.puc-rio.br

April 05 Prof. Ismael H. F. Santos - [email protected] 1

Modulo II CheckStyle

Professor Ismael H F Santos – [email protected]

March 09 Prof. Ismael H. F. Santos 2

Introduction to Apache Maven 2 Tutorial ibm developerWorks:

Bibliografia


Ementa

Traditional Build x Maven Build


Descrição

Ferramenta de desenvolvimento para ajudar programadores a escrever código Java aderente à um padrão de codificação.

Automatiza o processo de checagem de código Java para dispensar as pessoas desta tarefa enfadonha mas que é importante.

Ideal para projetos que queiram impor um padrão de codificação.


Descrição

É altamente configurável e pode ser usado como apoio para quase todos os padrões de codificação.

Pode checar muitos aspectos de um código fonte.

Sua funcionalidade principal era checar trechos de layout de código.

Com a mudança da arquitetura na versão 3 mais e mais checagens para outros propósito vem sendo adicionadas.


Descrição Atualmente fornece checagens que encontram

problemas de design de classe, código duplicado, padrões de bug.

Pode ser configurado no pom do projeto. Inclui conjuntos de regras predefinidas:

sun_checks.xml turbine_checks.xml avalon_checks.xml maven_checks.xml

Um conjunto de regras customizado pode ser especificado na configuração.


Descrição

Metas: checkstyle:checkstyle - efetua análise Checkstyle

e gera um relatório sobre as violações checkstyle:check - efetua uma checagem de

violação contra a última passada do Checkstyle para ver se há alguma violação:

Lê o arquivo de saída do Checkstyle Conta o número de violações encontradas Exibe as violações no console


Como baixar o plugin da Internet e instala-lo no Eclipse

Dentro do Eclipse, clique em "Help->Software Updates->Find and Install".



Selecione "Search for new features to install" e clique em "Next".



Clique "New Remote Site...".



Digite "Checkstyle" para o nome do plugin. Digite "http://eclipse-cs.sourceforge.net/update" para a URL. Clique em "OK".



Clique em "Finish".



Aguarde a Busca.



Clique nas setas à esquerda para abrir os detalhes. Marque "Eclipse Checkstyle Plug-in" e "Maven Optional Components". Clique em "Next".



Selecione "I accept the terms in the license agreements". Clique em "Next".



Clique em "Finish".



Aguarde o Downloading.



Clique em "Install All".



Aguarde a Instalação.



Clique em "Yes" para reiniciar o Eclipse.


Como usar no Eclipse Clique com o botão direito do mouse no pom.xml do projeto. Selecione "Run As" e clique em "4 Maven build...".


Como usar no Eclipse Clique em "Select...".


Como usar no Eclipse Localize "checkstyle" na lista, clique na seta à esquerda, clique em

"checkstyle" e clique em "OK".


Como usar no Eclipse Clique em "Run".


Como usar no Eclipse O relatório será exibido em "Console" após a linha [checkstyle:checkstyle].


Como usar no Eclipse Clique com o botão direito do mouse no projeto. Selecione "Checkstyle" e clique em "Check Code with Checkstyle".


Como usar no Eclipse A lista de erros aparecerá em "Problems".


Como usar no Eclipse

Clicando duas vezes na linha de um erro, a janela de código é aberta: Uma lupa contendo informações é exibida à

esquerda das linhas com erro Linhas com erro são selecionadas em amarelo A posição do erro é marcada em azul

Veja os três exemplos que seguem:


Como usar no Eclipse Exemplo 1:






Fontes

http://checkstyle.sourceforge.net/index.html http://eclipse-cs.sourceforge.net/

Documents

April 05 Prof. Ismael H. F. Santos - [email protected] 1 Modulo II CheckStyle Professor Ismael H F Santos – [email protected]@tecgraf.puc-rio.br