StyleCop no Visual Studio 2013

Update – 25.11.2013

andyr liberou, nesse final de semana, mais uma versão do StyleCop. Agora, com suporte oficial ao Visual Studio 2013.

Update – 30.10.2013

O usuário csdahlberg criou uma branch do StyleCop que da suporte ao Visual Studio 2013. Ele disponibiliza uma versão compilada nesse link.

StyleCop

StyleCop é uma ferramenta desenvolvida por um funcionário da Microsoft chamado Jason Allor com o intuito de ajudar a padronizar o estilo de escrita de código C#.  Hoje a Microsoft não responde mais pela ferramenta e essa responsabilidade foi delegada para a comunidade. As regras do StyleCop incluem documentação de código, nomenclaturas, espaçamento, entre outras. A lista completa com todas as regras podem ser encontradas aqui.

Manter o código organizado e padronizado quando você trabalha sozinho pode ser possível, com um time de duas ou três pessoas pode ser viável, mas com qualquer número maior que esse, fatalmente você vai acabar precisando de uma ferramenta como o StyleCop. Com ela, a validação da qualidade do código pode ser feita de forma automática.

StyleCop no Visual Studio 2013

Infelizmente, ainda não está disponível uma extensão do StyleCop para Visual Studio 2013 Preview. Mas, felizmente, você pode integrar ao projeto utilizando um pacote do NuGet chamado StyleCop.MSBuild. Basta adicionar ao projeto como você faria com qualquer outro pacote e na próxima vez que você tentar compilar o projeto o Visual Studio apresentará todos os warnings referentes ao StyleCop.

stylecop2

O StyleCop acompanha um arquivo de settings que contém todas as regras que você deseja utilizar no seu projeto, você pode facilmente editar esse arquivo utilizando uma ferramenta chamada StyleCop Settings Editor. Quando você baixar o pacote a ferramenta ficará instalada em “.\packages\StyleCop.MSBuild.4.7.45.0\tools\”. Basta executar a ferramenta passando o arquivo de configuração como parâmetro da seguinte forma:

> StyleCopSettingsEditor.exe Settings.StyleCop

stylecopPara mim, a melhor forma é copiar o arquivo de configuração da pasta packages para o mesmo nível do arquivo da solução. Dessa forma você pode subi-lo para o controle de versão, uma vez que o pacote do NuGet não precisa ficar versionado. Se você precisar de regras específicas para cada projeto, basta copiar o arquivo para dentro da pasta do projeto, assim você terá um arquivo de settings diferente para cada projeto.

Anúncios

2 Responses to StyleCop no Visual Studio 2013

  1. Muito interessante a ferramenta! Principalmente para mim que não tem o costume de fazer comentários no código.

    • É verdade, eu também não. O bom é escolher as regras que fazem mais sentido. Tem muita regra que pode não se adequar a nossa forma de trabalho, então podemos usar a ferramenta de settings para remover as regras que não fazem muito sentido. Conheço gente que não concorda de forma alguma que o using tem que ficar dentro do namespace. :)

Deixe um comentário

Preencha os seus dados abaixo ou clique em um ícone para log in:

Logotipo do WordPress.com

Você está comentando utilizando sua conta WordPress.com. Sair / Alterar )

Imagem do Twitter

Você está comentando utilizando sua conta Twitter. Sair / Alterar )

Foto do Facebook

Você está comentando utilizando sua conta Facebook. Sair / Alterar )

Foto do Google+

Você está comentando utilizando sua conta Google+. Sair / Alterar )

Conectando a %s

%d blogueiros gostam disto: