Visual Studio 2010 SDK -- 如何在 XML 注释组旁边放置装饰？

Question

我无法找到如何执行此操作，并且 Visual Studio SDK 参考也不是很有帮助。

我试图弄清楚如何获取 XML 注释的 NormalizedSnapshotSpanCollection 。我想在它们旁边放置一个图标...我不想在每行旁边放置一个图标，而只想在每组的第一行旁边放置一个图标...

///<summary>SomeXML Comment</summary>   [ICON]
///<remarks>some remarks</remarks>
public void Foo()
{
    ///Some false XML comment line that does not get an icon.
}

Answer 1

这是我能得到的，我认为它与你需要的非常相似。如果您有疑问，我将用更多详细信息更新此内容。

我从 此示例来自 VS 2010 SDK 网站。它已经非常接近您的需要，但还需要几个步骤。

---

下载C#版本，解压到文件夹，编译。要运行它并测试，您需要转到“项目”>“属性>调试

您需要选择“启动外部程序”选项并设置 VS 2010 应用程序的路径，例如 C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE\devenv.exe

在命令行参数中设置： /rootsuffix Exp

现在你应该能够运行它，在打开的 VS 中创建一些示例项目，如果你在任何地方键入一个六位数，例如00AA00 它将显示为具有相应颜色的矩形。关闭调试 VS 实例。

---

现在让我们编辑一些代码。在 ColorAdornmentTagger.cs 中注释定义 #define HIDING_TEXT。这将在文本旁边显示装饰，而不是代替它。

在同一个文件中，您需要找到 SnapshotSpan adornmentSpan 的初始化位置，并将该行更改为：

SnapshotSpan adornmentSpan = new SnapshotSpan(colorTagSpans[0].End, 0);

这会将装饰放置在文本范围之后，而不是之前。

---

在ColorTagger.cs中。更改构造函数中的正则表达式，因此构造函数现在看起来像这样，

    internal ColorTagger(ITextBuffer buffer)
        : base(
        buffer, 
        new[] { new Regex(@"/// <summary>.*", RegexOptions.Compiled | RegexOptions.CultureInvariant | RegexOptions.IgnoreCase) }
        )
    {
    }

这将设置正则表达式以识别方法注释行。

此类中的其他方法我们不会使用，您可以注释它们或返回一些随机颜色。

---

在“ColorAdornment.cs”中。这是装饰 WPF 控件本身。首先将基类从 Button 更改为 ContentControl。将类的构造函数更改为

    internal ColorAdornment(ColorTag colorTag)
    {
        BitmapImage image = new BitmapImage(); 
        using (FileStream stream = File.OpenRead("c:\\temp\\sologo.png")) 
        { 
            image.BeginInit(); 
            image.StreamSource = stream; 
            image.CacheOption = BitmapCacheOption.OnLoad; 
            image.EndInit(); 
        }

        this.Content = new Image() { Margin = new Thickness(20,0,0,0), Width = 100, Height = 30, Source = image };
    }

您可以将图像路径更改为您需要的图像路径。我刚刚从维基百科下载了 SO 徽标并将其放入我的临时文件夹中。

编译并运行。您应该能够在调试 VS 实例中的注释旁边看到 SO 徽标。

---

一些额外的说明。

首先，通过这种方式，您将获得一个工作原型，您应该根据需要重命名类并清理代码。

其次，当我调试它时，我的调试 VS 有时会冻结。我认为这可能与 IntraTextAdornmentTagger.cs 中的锁有关。

如果您还看到冻结，请尝试以这种方式更新以下方法：

    protected void InvalidateSpans(IList<SnapshotSpan> spans)
    {
        if (spans.Count == 0)
            return;
        bool wasEmpty = false;
        lock (this.invalidatedSpans)
        {
            wasEmpty = this.invalidatedSpans.Count == 0;
            this.invalidatedSpans.AddRange(spans);
        }

        if (wasEmpty)
            this.view.VisualElement.Dispatcher.BeginInvoke(new Action(AsyncUpdate));
    }

并以这种方式更新 AsyncUpdate：

    private void AsyncUpdate()
    {
        // Store the snapshot that we're now current with and send an event
        // for the text that has changed.
        if (this.snapshot != this.view.TextBuffer.CurrentSnapshot)
        {
            this.snapshot = this.view.TextBuffer.CurrentSnapshot;

            Dictionary<SnapshotSpan, TAdornment> translatedAdornmentCache = new Dictionary<SnapshotSpan, TAdornment>();

            foreach (var keyValuePair in this.adornmentCache)
                translatedAdornmentCache.Add(keyValuePair.Key.TranslateTo(this.snapshot, SpanTrackingMode.EdgeExclusive), keyValuePair.Value);

            this.adornmentCache = translatedAdornmentCache;
        }

        List<SnapshotSpan> spansCopy;
        lock (this.invalidatedSpans)
        {
            spansCopy = this.invalidatedSpans.ToList();
            this.invalidatedSpans.Clear();
        }

        List<SnapshotSpan> translatedSpans = spansCopy.Select(s => s.TranslateTo(this.snapshot, SpanTrackingMode.EdgeInclusive)).ToList();

        if (translatedSpans.Count == 0)
            return;

        var start = translatedSpans.Select(span => span.Start).Min();
        var end = translatedSpans.Select(span => span.End).Max();

        RaiseTagsChanged(new SnapshotSpan(start, end));
    }