如何为VSIX项目添加可在扩展任意位置输出的调试控制台？

方法一：利用Visual Studio内置输出窗口（推荐） #

直接复用VS自带的输出窗口，无需额外创建UI，是最简便的调试输出方式。

步骤1：初始化专属输出窗格 #

在扩展启动逻辑中（比如Package类的Initialize方法），创建或获取专属的输出窗格：

using Microsoft.VisualStudio.Shell;
using Microsoft.VisualStudio.Shell.Interop;
using System;

public sealed class YourExtensionPackage : Package
{
    private IVsOutputWindowPane _debugPane;

    protected override void Initialize()
    {
        base.Initialize();
        
        // 获取VS输出窗口服务
        var outputWindow = (IVsOutputWindow)GetGlobalService(typeof(SVsOutputWindow));
        // 自定义窗格的唯一GUID（可通过VS工具生成新GUID）
        var paneGuid = new Guid("12345678-1234-1234-1234-1234567890AB");
        
        // 创建或获取已存在的窗格
        outputWindow.CreatePane(ref paneGuid, "我的扩展调试控制台", 1, 0);
        outputWindow.GetPane(ref paneGuid, out _debugPane);
    }
}

步骤2：封装全局调用的日志工具 #

创建静态类，方便在扩展任意位置直接调用输出：

public static class DebugLogger
{
    private static IVsOutputWindowPane _pane;

    static DebugLogger()
    {
        var outputWindow = (IVsOutputWindow)Package.GetGlobalService(typeof(SVsOutputWindow));
        var paneGuid = new Guid("12345678-1234-1234-1234-1234567890AB");
        outputWindow.GetPane(ref paneGuid, out _pane);
    }

    public static void Log(string message)
    {
        // 线程安全的输出方法，支持非UI线程调用
        _pane?.OutputStringThreadSafe($"[{DateTime.Now:HH:mm:ss}] {message}\n");
    }
}

// 调用示例
DebugLogger.Log("Hello from VSIX extension!");

方法二：创建自定义调试控制台窗口 #

如果需要独立的调试窗口，可以创建ToolWindow作为专属控制台：

步骤1：添加ToolWindow项 #

右键VSIX项目 → 添加 → 新建项 → 选择「Tool Window」，命名为DebugConsoleWindow。

步骤2：设计控制台UI #

修改ToolWindow的XAML，添加只读文本框用于显示日志：

<UserControl x:Class="YourExtension.DebugConsoleWindowControl"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
    <Grid>
        <TextBox x:Name="DebugTextBox" 
                 IsReadOnly="True"
                 VerticalScrollBarVisibility="Auto"
                 HorizontalScrollBarVisibility="Auto"
                 AcceptsReturn="True"
                 TextWrapping="Wrap"
                 Background="#1E1E1E"
                 Foreground="#D4D4D4"/>
    </Grid>
</UserControl>

步骤3：实现线程安全的输出方法 #

在ToolWindow的代码-behind中添加日志追加逻辑：

using System;
using System.Windows.Threading;

public partial class DebugConsoleWindow : ToolWindowPane
{
    public DebugConsoleWindow() : base(null)
    {
        Content = new DebugConsoleWindowControl();
    }

    public void AppendLog(string message)
    {
        var control = Content as DebugConsoleWindowControl;
        if (control.DebugTextBox.Dispatcher.CheckAccess())
        {
            control.DebugTextBox.AppendText($"[{DateTime.Now:HH:mm:ss}] {message}\n");
            control.DebugTextBox.ScrollToEnd();
        }
        else
        {
            // 跨线程调用时切换到UI线程
            control.DebugTextBox.Dispatcher.Invoke(() => AppendLog(message));
        }
    }
}

步骤4：在任意位置调用输出 #

获取ToolWindow实例并输出调试信息：

using Microsoft.VisualStudio.Shell.Interop;

// 显示并获取调试控制台窗口
var uiShell = (IVsUIShell)Package.GetGlobalService(typeof(SVsUIShell));
var windowGuid = typeof(DebugConsoleWindow).GUID;
uiShell.FindToolWindow((uint)__VSFINDTOOLWIN.FTW_fForceCreate, ref windowGuid, out var frame);
frame.Show();

// 输出调试信息
var debugConsole = frame.FrameView as DebugConsoleWindow;
debugConsole.AppendLog("Hello from custom debug console!");

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