Návod: Konfigurace a používání vlastní sady pravidel

Článek
06/08/2015

Tento návod ukazuje, jak použít nástroje pro analýzu kódu, které byly nakonfigurovány pro použití přizpůsobené sady pravidel na knihovnu tříd.Je možné zvolit sadu pravidel, která se týká typu projektu určeného pro konkrétní řešení, nebo alternativní sady pravidel, které splňují specifické potřeby jako procházení starší verze kódu a hledání chyb, které mohou být opraveny nenarušujícím způsobem.V obou případech mohou být sady pravidel přizpůsobeny, aby ladily s požadavky projektu.

Tento návod bude popisovat tyto procesy:

Vytvoření knihovny tříd.
Výběr sady pravidel Základní pravidla obecných zásad návrhu společnosti Microsoft pro analýzu kódu.
Přidání vlastního kódu třídy.
Spuštění analýzy kódu.
Přizpůsobení sady pravidel.
Spuštění analýzy kódu a zjištění, jak se přizpůsobená pravidla chovají.

Požadavky

Visual Studio Ultimate, Visual Studio Premium nebo Visual Studio Professional.

Použití sady pravidel v analýze kódu

Nejprve vytvořte jednoduchou knihovnu tříd.

Vytvoření knihovny tříd

V nabídce Soubor klikněte na příkaz Nový a potom klikněte na příkaz Projekt.
V dialogovém okně Nový projekt klikněte v seznamu Typy projektů na položku Visual C#.
V položce Visual C# zvolte položku Knihovna tříd.
Do textového pole Název zadejte hodnotu RuleSetSample a klikněte na tlačítko OK.

Nyní zvolíte sadu pravidel Základní pravidla obecných zásad návrhu společnosti Microsoft a uložíte ji společně se svým projektem.

Výběr sady pravidel pro analýzu kódu

V nabídce Analyzovat klikněte na tlačítko Konfigurovat analýzu kódu pro projekt RuleSetSample.

Zobrazí se nastavení konfigurace pro analýzu kódu.
V rozevíracím seznamu Spustit tuto sadu pravidel vyberte Všechny pravidla společnosti Microsoft.

Další informace o dostupných sadách pravidel naleznete v Referenční dokumentace sady pravidel nástroje Analýza kódu.

Pro úpravu projektového souboru podle zadaných informací o sadách pravidel a jejich nastavení klikněte v nabídce Soubor na položku Uložit vybrané položky .

Tip

Ve skutečných situacích je pro prioritizaci oprav vhodné pro analýzu kódu použít sadu pravidel Minimální doporučená pravidla, opravit potřebné problémy a poté postupně přidávat další pravidla nebo sady pravidel k nalezení a opravě dalších problémů.

Dále přidáte kód do knihovny třídy, který bude demonstrovat porušení pravidla CA1704 "Identifikátory by měly být správně zadány" při analýze kódu.Další informace naleznete v tématu CA1704: Identifikátory by měly být zadány správně.

Přidání vlastního kódu

V Průzkumníku řešení otevřete soubor Class1.cs a nahraďte existující kód následujícím kódem:

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);
        }
    }
}

Nyní můžete spustit analýzu kódu na projektu RuleSetSample a zjistit všechny nalezené chyby a upozornění v okně Seznam chyb.

Spuštění analýzy kódu na projektu RuleSetSample

V nabídce Analyzovat klikněte na položku Spustit analýzu kódu projektu RuleSetSample.
V okně Seznam chyb klikněte na položku Upozornění a poté klikněte na záhlaví sloupce Popis, abyste upozornění seřadili alfanumericky.

Ve skutečných aplikacích byste opravili jakékoli porušení pravidel, které je v tuto chvíli vhodné opravit, nebo volitelně vypnuli nebo potlačili pravidla, která nejsou k opravě vhodná.Další informace naleznete v tématu Potlačení upozornění použitím atributu SuppressMessage.
Všimněte si upozornění CA1704.Porušení tohoto pravidla označují, že byste měli "zvážit pojmenování parametrů výstižnějšími názvy." Nyní můžete tento problém ve svém kódu opravit nebo můžete zakázat toto pravidlo podle následujícího postupu.

Nyní přizpůsobíte sadu pravidel, abyste z ní vyloučili upozornění CA1704, "Identifikátory by měly být správně zadány".

Přizpůsobení sady pravidel pro projekt, aby neobsahovala určité pravidlo

V nabídce Analyzovat klikněte na tlačítko Konfigurovat analýzu kódu pro projekt RuleSetSample.
V rozevíracím seznamu Spustit tuto sadu pravidel ověřte, zda je stále označena položka Všechna pravidla společnosti Microsoft, a poté klikněte na tlačítko Otevřít.Zobrazí se stránka sady pravidel.
Rozbalte uzel kategorie Microsoft.Naming a vyberte upozornění CA1704.
Ve sloupci Akce vyberte položku Žádná. To zabrání zobrazení upozornění nebo chyby CA1704 v okně Seznam chyb.

Nyní je vhodný čas experimentovat s různými tlačítky panelu nástrojů a možnostmi filtrování, abyste se seznámili s jejich funkčností.Můžete například použít rozevírací seznam Seskupit podle na pomoc při vyhledání určitého pravidla nebo kategorie pravidel.Dalším příkladem je použití tlačítka Skrýt zakázaná pravidla na panelu nástrojů sady pravidel ke skrytí nebo zobrazení všech pravidel s hodnotou ve sloupci Akce nastavenou na Žádná.To může být užitečné, pokud chcete vyhledat všechna pravidla, která jste vypnuli, a ověřit, zda je stále chcete zakázat.
V menu Zobrazit, klepněte na příkaz Okno vlastností.Napište My Custom Rule Set do pole Název v okně Vlastnosti.Tím se změní zobrazovaný název nového pravidla v integrovaném vývojovém prostředí (IDE) Visual Studio.
V nabídce Soubor klikněte na položku Uložit sadu pravidel Všechna pravidla společnosti Microsoft, abyste uložili svou vlastní sadu pravidel.Přejděte do kořenové složky projektu.Do textového pole Název souboru zadejte hodnotu MyCustomRuleSet.Tato vlastní sada pravidel může nyní být vybrána k použití ve vlastním projektu.

Po vytvoření vlastní sady pravidel je na řadě konfigurace nastavení projektu a specifikovat, že tento projekt má využívat tuto novou sadu pravidel.

Specifikace použití nové sady pravidel v projektu

V Průzkumníku řešení klikněte pravým tlačítkem na projekt a poté zvolte položku Vlastnosti.
V záložce Vlastnosti klikněte na položku Analýza kódu.

V rozevíracím seznamu Spustit tuto sadu pravidel klikněte na položku <Procházet..>.Přejděte do kořenové složky projektu a zvolte položku MyCustomRuleSet.ruleset.Toto je nová sada pravidel, kterou jste vytvořili v předchozím postupu.
Pro uložení konfigurace projektu klikněte v nabídce Soubor na položku Uložit.Vlastní sada pravidel teď může být použita ve vlastním projektu.

Nakonec znova spustíte analýzu kódu pomocí sady pravidel MyCustomRuleSet.Všimněte si, že okno Seznam chyb již nezobrazí porušení pravidla CA1704.

Opětovné spuštění analýzy kódu na projektu RuleSetSample

V nabídce Analyzovat klikněte na položku Spustit analýzu kódu projektu RuleSetSample.
Všimněte si, že když v okně Seznam chyb kliknete na tlačítko Upozornění, již se nezobrazí upozornění na porušení pravidla CA1704 "Identifikátory by měly být správně zadány".

Sdílet prostřednictvím