Este artigo explica como utilizar a ferramenta StyleCop para melhorar as práticas de programação em C#.

Introdução

É sempre uma boa prática manter controlo nas normas de programação usadas num projeto, independentemente do número de programadores nele envolvidos. Não só ajuda a leitura e entendimento do código mas também ajuda a poupar imenso tempo e recursos durante a fase de manutenção. O StyleCop é uma ferramenta .NET GRATUITA que obriga que um estilo consistente seja usado no projeto.

Pré-requisitos

• Ambiente de desenvolvimento Windows Phone
• StyleCop

Instalar o StyleCop

O StyleCop pode ser obtido aqui e depois é necessário proceder à sua instalação. 

• 

  Passo 1 da Instalação

   
• 

  Passo 2 da Instalação

• 

  Passo 3 da Instalação

   
• 

  Passo 4 da Instalação

Escrever o exemplo de código

Para demonstrar a utilização do StyleCop, é necessário um pedaço de código. Vamos escrever uma simples função que irá mostrar uma MessageBox ao utilizador.

O código é o que se encontra em baixo.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Navigation;
using Microsoft.Phone.Controls;
using Microsoft.Phone.Shell;
using StyleCopUsage.Resources;
 
namespace StyleCopUsage
{
    public partial class MainPage : PhoneApplicationPage
    {
        // Constructor
        public MainPage()
        {
            InitializeComponent();
            greetVisitor();
        }
 
        private void greetVisitor()
        {
            MessageBox.Show("Hello, Visitor!");
        }
    }
}

Se tentarmos compilar/executar este pedaço de código, este irá compilar e executar com sucesso.

Executar o StyleCop

Vamos agora executar o StyleCop para verificar se alguma das regras de desenvolvimento em C# não foram respeitadas e se sim, quantas? Para executar o StyleCop, basta clicar com botão direito em qualquer página dentro da aplicação e selecionar a opçãoRun StyleCop ou em alternativa selecionar Tools>>Run StyleCop.

Os resultados da ferramente StyleCop podem ser vistos sobre a forma de Warnings na janela Error List como exemplificado abaixo.

Como pode ver, temos 19 warnings do StyleCop no nosso projeto que consiste apenas num ficheiro e numa função bastante simples. Todos estes warnings demonstram que as guidelines de desenvolvimento C# não estão a ser respeitadas. Agora pode imaginar quantos warnings existiriam num projeto de proporções médias e quão fácil seria para um programador não respeitar as guidelines de C# por completo. A situação piora ainda mais quando nós (os programadores), por vezes, necessitamos de enviar o código fonte aos nossos clientes, o que provoca neles uma má impressão.

Remover os Warnings do StyleCop

Os warnings do StyleCop podem facilmente ser removidos depois de lidos. Portanto, após remover a maioria dos Warnings do StyleCop fica com o aspeto demonstrado em baixo.

// -----------------------------------------------------------------------
// <copyright file="MainPage.xaml.cs" company="Sample Company">
// sample rights
// </copyright>
// <author>Pooja Arora</author>
// -----------------------------------------------------------------------
 
namespace StyleCopUsage
{
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Net;
    using System.Windows;
    using System.Windows.Controls;
    using System.Windows.Navigation;
    using Microsoft.Phone.Controls;
    using Microsoft.Phone.Shell;
    using StyleCopUsage.Resources;
 
    public partial class MainPage : PhoneApplicationPage
    {
        // Constructor
        public MainPage()
        {
            this.InitializeComponent();
            this.GreetVisitor();
        }
 
        private void GreetVisitor()
        {
            MessageBox.Show("Hello, Visitor!");
        }
    }
}

Os restantes warnings são mostrados abaixo. 

Definições do StyleCop

Existe uma opção para remover algumas ou todas as pré-definições do StyleCop. Estas definições podem ser acedidas seleccionando o projecto na janela Solution Explorer, clicando com o botão direito e selecionando StyleCop Settings. POr defeito todas as definições são aplicadas, no entanto podemos modificá-las consoante o tempo e os requisitos do nosso projecto

Vista padrão das Definições do StyleCop

Suponhamos que não queremos lidar com o tipo de warnings mencionados em baixo.

Restantes warnings do StyleCop

Para isto, podemos desmarcar a(s) checkbox(es) relevantes nas definições do StyleCop, como exemplificado em baixo.

Modifying StyleCop Settings

Depois de aplicar as definições referidas acima, tentamos novamente executar StyleCop e verificamos que todos os warnings foram removidos.

No warnings

Sumário

Desta forma é possível assegurar que todos nós (programadores) respeitamos as guidelines de desenvolvimento em C# usando a ferramenta StyleCop ao desenvolver aplicações Windows Phone.

Referências

• http://stylecop.codeplex.com/documentation