如何在Visual Studio扩展中获取光标所在的方法与类名称？

核心思路 #

Visual Studio的面包屑导航能正常显示未项目文件的类/方法信息，说明编辑器本身已经完成了语法解析。我们可以通过文本结构导航器（ITextStructureNavigator） 这一通用接口来复用这些解析结果，无需依赖项目关联的FileCodeModel。

具体实现步骤 #

1. 获取当前活动文本视图
   通过SVsTextManager服务获取当前激活的IVsTextView，这是编辑器视图的核心接口。

2. 获取文本缓冲区（ITextBuffer）
   利用IVsEditorAdaptersFactoryService将IVsTextView转换为WPF视图，进而获取包含文件内容的ITextBuffer——这个缓冲区不依赖项目，仅和当前编辑的内容绑定。

3. 获取语言对应的文本结构导航器
   通过ITextStructureNavigatorSelectorService，根据ITextBuffer的内容类型（ContentType，比如Python、HTML、SQL各自对应不同类型）获取对应的导航器，该导航器由对应语言的服务实现，保证语法解析的准确性。

4. 定位光标所在的类/方法
   将光标位置转换为文本快照点，调用导航器的GetSpanOfEnclosingElement方法，分别指定ElementTypes.Class和ElementTypes.Method类型，提取对应的元素范围及名称。

代码示例（C#） #

using Microsoft.VisualStudio.Editor;
using Microsoft.VisualStudio.Shell;
using Microsoft.VisualStudio.Text;
using Microsoft.VisualStudio.Text.Editor;
using Microsoft.VisualStudio.TextManager.Interop;
using Microsoft.VisualStudio.Language.Intellisense;

public string GetCurrentClassOrMethod()
{
    ThreadHelper.ThrowIfNotOnUIThread();

    // 1. 获取当前活动视图
    var textManager = (IVsTextManager)Package.GetGlobalService(typeof(SVsTextManager));
    textManager.GetActiveView(1, null, out var textView);
    if (textView == null) return null;

    // 2. 获取文本缓冲区
    var adapterService = (IVsEditorAdaptersFactoryService)Package.GetGlobalService(typeof(IVsEditorAdaptersFactoryService));
    var wpfTextView = adapterService.GetWpfTextView(textView);
    var textBuffer = wpfTextView.TextBuffer;
    if (textBuffer == null) return null;

    // 3. 获取文本结构导航器
    var navigatorSelector = (ITextStructureNavigatorSelectorService)Package.GetGlobalService(typeof(ITextStructureNavigatorSelectorService));
    var navigator = navigatorSelector.GetTextStructureNavigator(textBuffer);
    if (navigator == null) return null;

    // 4. 转换光标位置并获取包围元素
    textView.GetCaretPos(out int line, out int col);
    var snapshot = textBuffer.CurrentSnapshot;
    var caretPoint = snapshot.GetLineFromLineNumber(line).Start + col;

    // 优先获取方法
    var methodSpan = navigator.GetSpanOfEnclosingElement(caretPoint, ElementTypes.Method);
    if (!methodSpan.IsEmpty)
    {
        return snapshot.GetText(methodSpan);
    }

    // 再获取类
    var classSpan = navigator.GetSpanOfEnclosingElement(caretPoint, ElementTypes.Class);
    if (!classSpan.IsEmpty)
    {
        return snapshot.GetText(classSpan);
    }

    return null;
}

多语言适配说明 #

• 对于HTML、SQL等非面向对象语言，可调整ElementTypes参数（比如HTML用ElementTypes.Element，SQL用ElementTypes.Block），或通过GetNodeContaining方法遍历语法节点的父级，判断节点语义类型。
• 所有Visual Studio内置支持的语言，都会提供对应的ITextStructureNavigator实现，无需额外适配即可复用编辑器的语法解析能力。

注意事项 #

• 确保代码在UI线程执行：Visual Studio的编辑器API大多要求在UI线程调用，需用ThreadHelper.ThrowIfNotOnUIThread()校验。
• 处理边界情况：光标不在任何类/方法中时，返回null或空字符串即可。

内容的提问来源于stack exchange，提问作者Paulo Santos