Instruktaż: Konfigurowanie i korzystanie z reguły niestandardowe ustawić

Artykuł
02/27/2013

W tym przewodniku przedstawiono sposób użycia narzędzi do analizy kodu, które zostały skonfigurowane do użycia niestandardowego zestawu reguł w bibliotece klas.Możesz wybrać zestaw reguł, który odnosi się do typu projektu, określonego dla rozwiązania, lub możesz wybrać alternatywne zestawy reguł, aby spełnić szczególne potrzeby, takie jak skanowanie starszych wersji kodu w poszukiwaniu problemów, które mogą być rozwiązane w sposób niekluczowy.W każdym przypadku zestawy reguł mogą być także dostosowane do spełniania wymagań projektu.

W tym przewodniku przedstawione zostaną kroki przez te procesy:

Stwórz bibliotekę klas.
Wybierz zestaw reguł analizy kodu Podstawowe reguły zasad projektowania firmy Microsoft.
Dodaj własny kod do klasy.
Uruchom analizę kodu
Dostosuj zestaw reguł.
Uruchom analizę kodu i zobacz, jak działa zachowanie dostosowania zestawu reguł.

Wymagania wstępne

Visual Studio Ultimate, Visual Studio Premium, lub Visual Studio Professional

Korzystanie z zestawów reguł z analizą kodu

Najpierw, utwórz prostą bibliotekę klas.

Tworzenie biblioteki klas

W menu Plik, kliknij Nowy, a następnie kliknij Projekt.
W oknie dialogowym Nowy projekt, w obszarze Typy projektów, kliknij Visual C#.
W obszarze Visual C#, zaznacz Biblioteka klas.
W polu tekstowym Nazwa wpisz RuleSetSample, a następnie kliknij OK.

Następnie, zaznacz zestaw reguł Podstawowe reguły zasad projektowania firmy Microsoft i zapisz go z projektem.

Wybierz zestaw reguł analizy kodu

W menu Analizuj kliknij Konfiguracja analizy kodu dla RuleSetSample.

Pojawią się ustawienia konfiguracji dla analizy kodu.

W liście rozwijalnej Uruchom ten zestaw reguł zaznacz Wszystkie reguły Microsoft.

Aby uzyskać więcej informacji na temat dostępnych zestawów reguł, zobacz Odwołanie zestawu reguł analizy kodu.

W menu Plik kliknij Zapisz wybrane elementy , aby zaktualizować plik projektu z informacjami dotyczącymi wybranego zestawu reguł i jego ustawieniami.

Porada
W sytuacji rzeczywistej, dobrą praktyką do użycia dla określania priorytetów wśród problemów, w które chcesz celować analizą kodu, jest zaczęcie od zestawu reguł Minimalne zalecane reguły i poprawienie żądanych problemów, a następnie stopniowe dodawanie więcej reguł lub zestawów reguł do znajdowania i poprawiania dodatkowych problemów.

Następnie, dodaj jakiś kod do biblioteki klas, która zostanie użyta do demonstracji naruszeń reguły analizy kodu CA1704 "Identyfikatory powinny być napisane poprawnie".Aby uzyskać więcej informacji, zobacz CA1704: Identyfikatory powinny być pisane poprawnie.

Dodaj własny kod

W Eksploratorze rozwiązania, otwórz plik Class1.cs, odszukaj i zastąp istniejący kod poniższym:

using System;
using System.Collections.Generic;
using System.Text;

namespace RuleSetSample
{
    public class Class1
    {
        //The variable parameter names "a" and "b" will cause
        //the warning CA 1704 Microsoft.Naming "Consider 
        //providing a more meaningful name" to fire
        public int AddIntegers(int a, int b)
        {

            int sum = a + b;

            return (sum);
        }
    }
}

Teraz możesz uruchomić analizę kodu na projekcie RuleSetSample i poszukać wszelkich błędów i ostrzeżeń wygenerowanych w oknie Lista błędów.

Uruchomienie analizy kodu na projekcie RuleSetSample

W menu Analizuj, kliknij Uruchom analizę kodu w RuleSetSample.
W oknie Lista błędów, kliknij Ostrzeżenia, a następnie kliknij nagłówek kolumny Opis, aby posortować ostrzeżenia alfanumerycznie.

W aplikacji rzeczywistych, naprawiono by wszystkie naruszenia reguł warte naprawienia w tym momencie, lub opcjonalnie wyłączono by lub pominięto regułę, która została określona jako nie warta naprawy.Aby uzyskać więcej informacji, zobacz Pomija ostrzeżenia, za pomocą atrybutu SuppressMessage.
Zauważ ostrzeżenia CA1704.Te naruszenia reguły sugerują, że powinieneś "Rozważyć dostarczenie bardziej opisowych nazw dla parametrów." Możesz poprawić problem w kodzie lub wyłączyć tę regułę, jak to opisano w kolejnej procedurze.

Następnie dostosuj zestaw reguł do pomijania ostrzeżenia CA1704, "Identyfikatory powinny być napisane poprawnie".

Dostosowanie zestawu reguł do wyłączenia określonej reguły dla projektu

W menu Analizuj kliknij Konfiguracja analizy kodu dla RuleSetSample.
W liście rozwijalnej Uruchom ten zestaw reguł sprawdź, czy zestaw reguł Wszystkie reguły Microsoft jest nadal wyróżniony, a następnie kliknij Otwórz.Zostanie wyświetlona strona zestawu reguł.
Rozwiń węzeł kategorii Microsoft.Naming, a następnie wybierz ostrzeżenie CA1704.
W kolumnie Akcja, zaznacz Brak. Zapobiega to CA1704 przed wyświetlaniem jako ostrzeżenie lub błąd w oknie Lista błędów.

Teraz byłby odpowiedni moment na eksperymentowanie z różnymi przyciskami paska narzędzi i opcjami filtrowania, aby się z nimi zapoznać.Na przykład, możesz użyć listy rozwijalnej Grupuj według, aby uzyskać pomoc w zlokalizowaniu określonej reguły lub kategorii reguł.Innym przykładem jest to, że możesz używać przycisku Ukryj wyłączone zasady na stronach przycisku narzędzi zestawu reguł, by ukryć lub pokazać wszystkie reguły z kolumną Akcja ustawioną na Brak.Może to być przydatne, jeśli chcesz skanować w poszukiwaniu wszystkich reguł, które zostały wyłączone w celu sprawdzenia, czy nadal chcesz je wyłączyć.
W menu Widok, kliknij Okno właściwości.Wpisz My Custom Rule Set w polu Nazwa okna narzędzi Właściwości.Zmieni to nazwę wyświetlaną nowego zestawu reguł w Visual Studio IDE.
W menu Plik, kliknij Zapisz wszystkie Rules.ruleset Microsoft, aby zapisać niestandardowe zestawy reguł.Przejdź do folderu głównego projektu.W polu tekstowym NazwaPliku wpisz MyCustomRuleSet.Zestaw niestandardowych reguł może teraz zostać wybrany do użycia z projektem.

Gdy utworzyłeś nowy zestaw reguł, teraz musisz skonfigurować ustawienia projektu do określenia, że chcesz używać z nim nowy zestaw reguł.

Określenie nowego zestawu reguł do użytku z projektem

W Eksploratorze rozwiązań kliknij prawym przyciskiem myszy projekt, a następnie wybierz Właściwości.
Na karcie Właściwości kliknij pozycję Analiza kodu.

W liście rozwijalnej Uruchom ten zestaw reguł, kliknij <Przeglądaj..>.Przejdź do folderu głównego projektu kodu, a następnie wybierz MyCustomRuleSet.ruleset.Jest to nowy zestaw reguł, utworzony w poprzedniej procedurze.
W menu Plik, kliknij Zapisz, aby zapisać konfigurację projektu.Możesz teraz użyć niestandardowego zestawu reguł z projektem.

Wreszcie, uruchom ponownie analizę kodu, używając zestawu reguł MyCustomRuleSet.Zauważ, że okno Lista błędów nie wyświetli naruszenia reguły wydajności CA1704.

Uruchomienie analizy kodu projektu RuleSetSample po raz drugi

W menu Analizuj, kliknij Uruchom analizę kodu w RuleSetSample.
W oknie Lista błędów zauważ, że po kliknięciu Ostrzeżenia, nie widać więcej naruszeń ostrzeżenia CA1704 dla reguły "Identyfikatory powinny być napisane poprawnie".

Udostępnij za pośrednictwem