使用 Visual Studio SDK 确定插入符号是否位于注释块中

Question

场景

---

我希望仅当插入符号位于 Xml 注释块中时才在自定义菜单中启用命令

''' ... If caret is here, in a Vb.Net Xml comment block.

或

/// ... If caret is here, in a C# Xml comment block.

然后，预期结果的伪代码：

C#：

private void CmdExample_BeforeQueryStatus(object sender, EventArgs e) {
    // Enable this command only if the caret is in a Xml comment block.
    ((OleMenuCommand)sender).Enabled = IsCaretInXmlComment?();
}

Vb：

Private Sub CmdExample_BeforeQueryStatus(ByVal sender As Object, ByVal e As EventArgs) _
Handles cmdExample.BeforeQueryStatus

    ' Enable this command only if the caret is in a Xml comment block.
    DirectCast(sender, OleMenuCommand).Enabled = IsCaretInXmlComment?()

End Sub

问题

---

只是，我怎么能做到呢？在 Vb.Net 或 C# 中。

研究

---

我不知道该怎么做，所以我对 vsCMElement 枚举的值进行了反复试验，因为我看到了类似的 here，但是CodeElement2.Kind 属性总是抛出 NullReferenceException。

C#：

TextPoint tp = 
    ((TextSelection)MyDte.ActiveDocument.Selection).ActivePoint;

CodeElement2 ce = 
    MyDte.ActiveDocument.ProjectItem.FileCodeModel.
          CodeElementFromPoint(tp, vsCMElement.vsCMElementOther);

Vb：

Dim tp As TextPoint = 
    CType(MyDte.ActiveDocument.Selection, TextSelection).ActivePoint

Dim ce As CodeElement2 =
    MyDte.ActiveDocument.ProjectItem.FileCodeModel.
          CodeElementFromPoint(tp, vsCMElement.vsCMElementOther)

我也发现了这个 question，但是没有说明性的代码示例，我对此非常迷茫。

Answer 1

如果您的目标是 Visual Studio 2015 或更高版本，最好的方法是使用 Roslyn。有了它，您可以获得语法树，然后确定您是否在评论中。如果您查看我们对IsEntirelyWithinSingleLineDocComment 的实现，您会看到我们今天是如何做到的。如果您是 Roslyn 的新手，已经有一些问题可以帮助您获得语法树。

如果您需要定位低于该值的版本，那么自 Roslyn 于 2012 年首次发布以来，您就遇到了麻烦。一种常见的方法是询问分类信息，以确定某事是否是评论。分类是驱动您在编辑器中看到的文本着色的原因。如果您的文件获得ITextBuffer，则可以MEF 导入IClassifierAggregatorService 并要求分类，然后过滤到文档注释类型。 Noah Richard's original spell check sample 是一个很好的例子。