İzlenecek yol: Kenar boşluğu karakteri oluşturma

Özel düzenleyici uzantılarını kullanarak düzenleyici kenar boşluklarının görünümünü özelleştirebilirsiniz. Bu izlenecek yol, bir kod açıklamasında "yapılacaklar" sözcüğü her görüntülendiğinde gösterge kenar boşluğuna özel bir karakter ekler.

MEF projesi oluşturma

1. C# VSIX projesi oluşturun. (Yeni Proje iletişim kutusu, Visual C# / Genişletilebilirlik'i ve ardından VSIX Projesi'ni seçin.) Çözümü TodoGlyphTestolarak adlandırın.

2. Düzenleyici Sınıflandırıcısı proje öğesi ekleyin. Daha fazla bilgi için bkz . Düzenleyici öğesi şablonuyla uzantı oluşturma.

3. Varolan sınıf dosyalarını silin.

Karakteri tanımlama

Arabirimini çalıştırarak IGlyphFactory bir karakter tanımlayın.

Karakteri tanımlamak için

1. Bir sınıf dosyası ekleyin ve adını verin TodoGlyphFactory.

2. Bildirimleri kullanarak aşağıdaki kodu ekleyin.

   C#

   using System.ComponentModel.Composition;
   using System.Windows;
   using System.Windows.Shapes;
   using System.Windows.Media;
   using System.Windows.Controls;
   using Microsoft.VisualStudio.Text;
   using Microsoft.VisualStudio.Text.Editor;
   using Microsoft.VisualStudio.Text.Formatting;
   using Microsoft.VisualStudio.Text.Tagging;
   using Microsoft.VisualStudio.Utilities;
   

   VB

   Imports System.ComponentModel.Composition
   Imports System.Windows
   Imports System.Windows.Shapes
   Imports System.Windows.Media
   Imports System.Windows.Controls
   Imports Microsoft.VisualStudio.Text
   Imports Microsoft.VisualStudio.Text.Editor
   Imports Microsoft.VisualStudio.Text.Formatting
   Imports Microsoft.VisualStudio.Text.Tagging
   Imports Microsoft.VisualStudio.Utilities
   

3. uygulayan IGlyphFactoryadlı TodoGlyphFactory bir sınıf ekleyin.

   C#

   internal class TodoGlyphFactory : IGlyphFactory
   

   VB

   Friend Class TodoGlyphFactory
       Implements IGlyphFactory
   

4. Karakterin boyutlarını tanımlayan özel bir alan ekleyin.

   C#

   const double m_glyphSize = 16.0;
   

   VB

   Const m_glyphSize As Double = 16.0
   

5. Glif kullanıcı arabirimi (UI) öğesini tanımlayarak uygulayın GenerateGlyph . TodoTag daha sonra bu kılavuzda tanımlanır.

   C#

   public UIElement GenerateGlyph(IWpfTextViewLine line, IGlyphTag tag)
   {
       // Ensure we can draw a glyph for this marker.
       if (tag == null || !(tag is TodoTag))
       {
           return null;
       }
   
       System.Windows.Shapes.Ellipse ellipse = new Ellipse();
       ellipse.Fill = Brushes.LightBlue;
       ellipse.StrokeThickness = 2;
       ellipse.Stroke = Brushes.DarkBlue;
       ellipse.Height = m_glyphSize;
       ellipse.Width = m_glyphSize;
   
       return ellipse;
   }
   

   VB

   Public Function GenerateGlyph(ByVal line As IWpfTextViewLine, ByVal tag As IGlyphTag) As System.Windows.UIElement Implements IGlyphFactory.GenerateGlyph
       ' Ensure we can draw a glyph for this marker.
       If tag Is Nothing OrElse Not (TypeOf tag Is TodoTag) Then
           Return Nothing
       End If
   
       Dim ellipse As Ellipse = New Ellipse()
       ellipse.Fill = Brushes.LightBlue
       ellipse.StrokeThickness = 2
       ellipse.Stroke = Brushes.DarkBlue
       ellipse.Height = m_glyphSize
       ellipse.Width = m_glyphSize
   
       Return ellipse
   
   End Function
   

6. uygulayan IGlyphFactoryProvideradlı TodoGlyphFactoryProvider bir sınıf ekleyin. Bu sınıfı "TodoGlyph", OrderAttribute After VsTextMarker, "ContentTypeAttributecode" ve TagTypeAttribute todoTag ile NameAttribute dışarı aktarın.

   C#

   [Export(typeof(IGlyphFactoryProvider))]
   [Name("TodoGlyph")]
   [Order(After = "VsTextMarker")]
   [ContentType("code")]
   [TagType(typeof(TodoTag))]
   internal sealed class TodoGlyphFactoryProvider : IGlyphFactoryProvider
   

   VB

   <Export(GetType(IGlyphFactoryProvider)), Name("TodoGlyph"), Order(After:="VsTextMarker"), ContentType("code"), TagType(GetType(TodoTag))>
   Friend NotInheritable Class TodoGlyphFactoryProvider
       Implements IGlyphFactoryProvider
   

7. örneğini GetGlyphFactory ekleyerek TodoGlyphFactoryyöntemini uygulayın.

   C#

   public IGlyphFactory GetGlyphFactory(IWpfTextView view, IWpfTextViewMargin margin)
   {
       return new TodoGlyphFactory();
   }
   

   VB

   Public Function GetGlyphFactory(ByVal view As IWpfTextView, ByVal margin As IWpfTextViewMargin) As IGlyphFactory Implements IGlyphFactoryProvider.GetGlyphFactory
       Return New TodoGlyphFactory()
   End Function
   

Todo etiketi ve etiket tanımlama

Önceki adımlarda tanımladığınız UI öğesi ile gösterge kenar boşluğu arasındaki ilişkiyi tanımlayın. Etiket türü oluşturun, etiketleyin ve bir etiketleme sağlayıcısı kullanarak dışarı aktarın.

Todo etiketi ve etiket tanımlamak için

1. Projeye yeni bir sınıf dosyası ekleyin ve olarak adlandırın TodoTagger.

2. Aşağıdaki içeri aktarmaları ekleyin.

   C#

   using System;
   using System.Collections.Generic;
   using System.ComponentModel.Composition;
   using Microsoft.VisualStudio.Text;
   using Microsoft.VisualStudio.Text.Tagging;
   using Microsoft.VisualStudio.Text.Editor;
   using Microsoft.VisualStudio.Text.Classification;
   using Microsoft.VisualStudio.Utilities;
   

   VB

   Imports System
   Imports System.Collections.Generic
   Imports System.ComponentModel.Composition
   Imports Microsoft.VisualStudio.Text
   Imports Microsoft.VisualStudio.Text.Tagging
   Imports Microsoft.VisualStudio.Text.Editor
   Imports Microsoft.VisualStudio.Text.Classification
   Imports Microsoft.VisualStudio.Utilities
   

3. adlı TodoTagbir sınıf ekleyin.

   C#

   internal class TodoTag : IGlyphTag
   

   VB

   Friend Class TodoTag
       Implements IGlyphTag
   
       Public Sub New()
           MyBase.New()
       End Sub
   End Class
   

4. türünde TodoTaguygulayan ITagger<T> adlı TodoTagger sınıfını değiştirin.

   C#

   internal class TodoTagger : ITagger<TodoTag>
   

   VB

   Friend Class TodoTagger
       Implements ITagger(Of TodoTag)
   

5. sınıfına TodoTagger , sınıflandırma aralıklarında bulunacak metin için ve IClassifier için özel alanlar ekleyin.

   C#

   private IClassifier m_classifier;
   private const string m_searchText = "todo";
   

   VB

   Private m_classifier As IClassifier
   Private Const m_searchText As String = "todo"
   

6. Sınıflandırıcıyı ayarlayan bir oluşturucu ekleyin.

   C#

   internal TodoTagger(IClassifier classifier)
   {
       m_classifier = classifier;
   }
   

   VB

   Friend Sub New(ByVal classifier As IClassifier)
       m_classifier = classifier
   End Sub
   

7. GetTags Adları "açıklama" sözcüğünü içeren ve metni arama metnini içeren tüm sınıflandırma aralıklarını bularak yöntemini uygulayın. Arama metni her bulunduğunda, türünde yeni TagSpan<T> bir verim TodoTagelde edin.

   C#

   IEnumerable<ITagSpan<TodoTag>> ITagger<TodoTag>.GetTags(NormalizedSnapshotSpanCollection spans)
   {
       foreach (SnapshotSpan span in spans)
       {
           //look at each classification span \
           foreach (ClassificationSpan classification in m_classifier.GetClassificationSpans(span))
           {
               //if the classification is a comment
               if (classification.ClassificationType.Classification.ToLower().Contains("comment"))
               {
                   //if the word "todo" is in the comment,
                   //create a new TodoTag TagSpan
                   int index = classification.Span.GetText().ToLower().IndexOf(m_searchText);
                   if (index != -1)
                   {
                       yield return new TagSpan<TodoTag>(new SnapshotSpan(classification.Span.Start + index, m_searchText.Length), new TodoTag());
                   }
               }
           }
       }
   }
   

   VB

   Private Function GetTags(ByVal spans As NormalizedSnapshotSpanCollection) As IEnumerable(Of ITagSpan(Of TodoTag)) Implements ITagger(Of TodoTag).GetTags
       Dim list As List(Of ITagSpan(Of TodoTag))
       list = New List(Of ITagSpan(Of TodoTag))()
   
       For Each span As SnapshotSpan In spans
           'look at each classification span \
           For Each classification As ClassificationSpan In m_classifier.GetClassificationSpans(span)
               'if the classification is a comment
               If classification.ClassificationType.Classification.ToLower().Contains("comment") Then
                   'if the word "todo" is in the comment,
                   'create a new TodoTag TagSpan
                   Dim index As Integer = classification.Span.GetText().ToLower().IndexOf(m_searchText)
                   If index <> -1 Then
                       list.Add(New TagSpan(Of TodoTag)(New SnapshotSpan(classification.Span.Start + index, m_searchText.Length), New TodoTag()))
                   End If
               End If
           Next classification
       Next span
   
       Return list
   End Function
   

8. Bir TagsChanged olay bildirin.

   C#

   public event EventHandler<SnapshotSpanEventArgs> TagsChanged;
   

   VB

   Public Event TagsChanged(ByVal sender As Object, ByVal e As Microsoft.VisualStudio.Text.SnapshotSpanEventArgs) Implements Microsoft.VisualStudio.Text.Tagging.ITagger(Of TodoTag).TagsChanged
   

9. uygulayan ITaggerProvideradlı TodoTaggerProvider bir sınıf ekleyin ve bunu "code" ve TagTypeAttribute todoTag ile ContentTypeAttribute dışarı aktarın.

   C#

   [Export(typeof(ITaggerProvider))]
   [ContentType("code")]
   [TagType(typeof(TodoTag))]
   class TodoTaggerProvider : ITaggerProvider
   

   VB

   <Export(GetType(ITaggerProvider)), ContentType("code"), TagType(GetType(TodoTag))>
   Friend Class TodoTaggerProvider
       Implements ITaggerProvider
   

10. öğesini içeri aktarın IClassifierAggregatorService.

    C#

    [Import]
    internal IClassifierAggregatorService AggregatorService;
    

    VB

    <Import()>
    Friend AggregatorService As IClassifierAggregatorService
    

11. örneğini CreateTagger ekleyerek TodoTaggeryöntemini uygulayın.

    C#

    public ITagger<T> CreateTagger<T>(ITextBuffer buffer) where T : ITag
    {
        if (buffer == null)
        {
            throw new ArgumentNullException("buffer");
        }
    
        return new TodoTagger(AggregatorService.GetClassifier(buffer)) as ITagger<T>;
    }
    

    VB

    Public Function CreateTagger(Of T As Microsoft.VisualStudio.Text.Tagging.ITag)(ByVal buffer As Microsoft.VisualStudio.Text.ITextBuffer) As Microsoft.VisualStudio.Text.Tagging.ITagger(Of T) Implements Microsoft.VisualStudio.Text.Tagging.ITaggerProvider.CreateTagger
        If buffer Is Nothing Then
            Throw New ArgumentNullException("buffer")
        End If
    
        Return TryCast(New TodoTagger(AggregatorService.GetClassifier(buffer)), ITagger(Of T))
    End Function
    

Kodu derleme ve test etme

Bu kodu test etmek için TodoGlyphTest çözümünü derleyin ve deneysel örnekte çalıştırın.

TodoGlyphTest çözümünü derlemek ve test etmek için

1. Çözümü oluşturun.

2. F5 tuşuna basarak projeyi çalıştırın. Visual Studio'nun ikinci bir örneği başlar.

3. Gösterge kenar boşluğunun gösterildiğinden emin olun. (Araçlar menüsünde Seçenekler'e tıklayın. Metin Düzenleyicisi sayfasında Gösterge kenar boşluğunun seçili olduğundan emin olun.)

4. Açıklamaları olan bir kod dosyası açın. Açıklama bölümlerinden birine "todo" sözcüğünü ekleyin.

5. Kod penceresinin solundaki gösterge kenar boşluğunda koyu mavi ana hatlı açık mavi bir daire görüntülenir.