İzlenecek Yol: Özel bir Kural Kümesini Yapılandırma ve Kullanma

Makale
06/08/2015

Bu izlenecek yolda, özelleştirilmiş bir kullanmak üzere yapılandırılmış kod çözümleme araçlarını kullanma gösterilmiştir kural kümesi bir sınıf kitaplığı üzerinde.Eski kod bölünemez bir yolla giderilen sorunlar için tarama gibi belirli bir gereksinimi karşılamak üzere alternatif kuralını ayarlar çözümünüz için belirtilen veya seçebileceğiniz proje türü ilişkilendiren bir kural kümesi seçebilirsiniz.Her iki durumda da, kural kümeleri de bunları proje gereksinimlerinizi ince için özelleştirilebilir.

Bu izlenecek yolda, bu işlemler adım şöyle:

Bir sınıf kitaplığı oluşturun.
Seçin Temel tasarım kılavuz kuralları kod çözümleme kural kümesi.
Kendi kodunuzu sýnýfýna ekleyin.
Kod çözümleme çalıştırın.
Kural kümesini özelleştirin.
Kodu çözümlemesini çalıştırmanız ve nasıl özelleştirme davranış works kural kümesi görürsünüz.

Önkoşullar

Visual Studio UltimateVisual Studio Premium veya Visual Studio Professional

Kural kullanarak kod analizi ile ayarlar

İlk olarak, basit bir sınıfı kitaplığı oluşturun.

Sınıf kitaplığı oluşturma

Dosya menüsünde, Yeni'yi ve sonra da Proje'yi tıklatın.
İçinde Yeni bir proje iletişim kutusunda altında Proje türleri,'ı Visual C#.
Altında Visual C#, select Class Library.
İçinde ad metin kutusuna RuleSetSample yazın ve ardından Tamam.

Daha sonra seçecek Temel tasarım kılavuz kuralları kural kümesi ve projenizi kaydetmek.

Kod çözümleme kural kümesi Seç

Üzerinde Analiz menüsünde,'ı Yapılandırma kodunu analiz RuleSetSample için.

Kod çözümleme için yapılandırma ayarları görüntülenir.

De Bu kural kümesi çalıştırmak aşağı açılan listesinde, select Tüm kurallar Microsoft.

Kullanılabilen kural kümeleri hakkında daha fazla bilgi için bkz: Kod analizi kural kümesi başvurusu.

Dosya menüsünde Kaydet seçili öğeler ayarlarına ve seçtiğiniz kural kümesi hakkında bilgi proje dosyasını güncelleştirmek için.

İpucu
Hedeflediğiniz kod analizi ile hangi sorunların öncelik sıralaması için kullanmak iyi bir başlamak gerçek durumda olan Önerilen Minimum kuralları kural kümesi istenilen sorunları düzeltmek ve daha fazla kural veya kuralı ayarlar bulmak ve diğer sorunları düzeltmek için artımlı olarak ekleyin.

Sonra bazı kod ihlalleri CA1704 göstermek için kullanılan sınıf kitaplığı ekleyeceksiniz "Tanımlayıcıları sözcüğünde" kod çözümleme kural.Daha fazla bilgi için bkz. CA1704: Tanımlayıcılar doğru yazılmalıdır.

Kendi kodu ekleyin

Solution Explorer'da Class1.cs dosyası açın ve varolan bir koda aşağıdakiyle Değiştir:

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

Şimdi RuleSetSample projede kodu çözümlemesini çalıştırmanız ve tüm hataları ve Uyarıları hata Listesi penceresinde oluşturulan arayın.

RuleSetSample projedeki kod çözümleme çalıştırın

Üzerinde Çözümle menüsünde,'ı Kod çözümleme çalıştırmak RuleSetSample.
Hata Listesi penceresi, Uyarılar 'ı Açıklama uyarılar sıralamak için sütun başlığını alfasayısal olarak.

Bir gerçek dünya uygulama, bu noktada çözme kurlar herhangi bir kural ihlalleri düzeltmek veya isteğe bağlı olarak devre dışı bırakmak veya onu düzeltmeye kurlar büyütülmeye çalışıldığını belirledi, kural bastır.Daha fazla bilgi için bkz. SuppressMessage Özniteliğini Kullanarak Uyarıları Bastırma.
CA1704 uyarıların dikkat edin.Bu kural, bu ihlalleri, "parametreler için daha anlamlı bir ad sağlayarak dikkate almalısınız emin." belirtmek Kodunuzda bu sorunu çözmek veya sonraki yordamda açıklandığı gibi kuralını devre dışı bırakmak.

Daha sonra kural kümesi CA1704 uyarı dışlamak için özelleştirmek, "Tanımlayıcıları doğru yazılması gereken".

Projenizi belirli bir kuralı devre dışı bırakmak set kural özelleştirme

Üzerinde Analiz menüsünde,'ı Yapılandırma kodunu analiz RuleSetSample için.
De Bu kural kümesi çalıştırmak aşağı açılan listesinde, aşağıdakileri doğrulayın Tüm kurallar Microsoft kural kümesi hala vurgulanmış ve ardından açık.Kural kümesi sayfası görüntülenir.
Microsoft.Naming kategori düümünü geniletin ve ardından CA1704 uyarı seçin.
Altında Eylem sütunu select yok. Bu CA1704 bir uyarı veya hata Listesi penceresinde hata olarak görüntülemelerini engeller.

Şimdi çeşitli araç çubuğu düğmeleri ile denemeler yapmak için iyi bir zaman olacaktır ve filtreleme seçenekleri onlarla tanımak istiyorsunuz.Örneğin, kullanmak Group By belirli kural veya kuralların kategori bulmaya yardımcı olmak için aşağı açılan liste.Kullanabileceğiniz diğer bir örnek ise Gizlemek devre dışı bırakılmış kuralları kurallarıyla göstermek veya gizlemek için kural kümesi sayfa araç çubuğundaki düğmesini Eylem sütun ayarlamak yok.Bu, hala onları devre dışı olmasını istediğinizi doğrulamak için kapatmış kuralları için taramak isterseniz yararlı olabilir.
Görünüm menüsünden Özellikler Penceresi'ni tıklayın.Type My Custom Rule Set Özellikler araç penceresinin adı kutusuna.Bu yeni kural kümesi görünen adını değiştirir Visual Studio IDE.
Üzerinde Dosya menüsünde,'ı Kaydetmek Microsoft tüm Rules.ruleset özelleştirilmiş kuralınızı kaydetmek üzere ayarlama.Projenizi kök klasörüne gidin.İçinde Dosya adı metin kutusuna, MyCustomRuleSet yazın.Proje ile kullanmak için özel bir kural kümesi şimdi seçilebilir.

Oluşturulan sizin yeni kural kümesi ile şimdi, kendisiyle ayarlamak yeni kuralınızın kullanmak istediğinizi belirtmek için proje ayarlarınızı yapılandırmanız gerekir.

Projenizde kullanmak için yeni kural kümesini belirtin

Solution Explorer'da proje sağ tıklatın ve sonra seçin özelliklerini.
İçinde özelliklerini sekmesinde Kod çözümleme.

De Bu kural kümesi çalıştırmak aşağı açılan liste'ı < Gözat...>.Kod projenizi kök klasörüne gidin ve MyCustomRuleSet.ruleset'ı seçin.Önceki yordamda oluşturduğunuz yeni bir kural kümesi budur.
Üzerinde Dosya menüsünde,'ı kaydetmek project yapılandırmanızı kaydetmek için.Projenizde özel kural kümesi artık kullanılabilir.

Son olarak kod çözümleme MyCustomRuleSet kural kümesini yeniden kullanmaya çalışacaktır.Hata Listesi penceresi CA1704 performans kuralı ihlali görüntülemez dikkat edin.

Kod çözümleme RuleSetSample projede ikinci kez çalıştırın.

Üzerinde Çözümle menüsünde,'ı Kod çözümleme çalıştırmak RuleSetSample.
' I tıklattığınızda hata Listesi penceresinde, dikkat edin Uyarılar, artık "Tanımlayıcıları doğru yazılması gereken" kural CA1704 uyarı ihlalleri konusuna bakın.

Aracılığıyla paylaş