Visual Studio 外接程序应在哪里存储其设置？

Question

目前，我将自定义插件的设置存储在注册表中，但这看起来像是一个拼凑。我想知道是否有一个官方的地方来存储加载项设置。我的偏好是将它们存储在 Visual Studio 存储设置的位置，以便可以轻松导出和导入它们。

是否可以使用 Visual Studio 设置来存储加载项设置，或者是否有更好的方法？

Answer 1

编辑

我对这个主题的最初回答有几个问题，我在使用它多年后发现了一些问题。为了完整起见，我将其包含在下面，但这是我对此的最新想法。

在 VSIX 中使用应用程序设置不是版本安全的。存储的设置文件路径的位置部分包括可执行文件的版本字符串和哈希值。当 Visual Studio 安装官方更新时，这些值会发生变化，从而更改设置文件路径。 Visual Studio 本身不支持使用应用程序设置，因此它不会尝试将此文件迁移到新位置，并且所有信息基本上都会丢失。
支持的设置方法是 WritableSettingsStore。它与应用程序设置非常相似，并且很容易通过 SVsServiceProvider 进行访问

public static WritableSettingsStore GetWritableSettingsStore(this SVsServiceProvider vsServiceProvider)
{
    var shellSettingsManager = new ShellSettingsManager(vsServiceProvider);
    return shellSettingsManager.GetWritableSettingsStore(SettingsScope.UserSettings);
}

原始答案

最直接的方法是使用 .Net 的 应用程序设置 基础结构，用于存储任何设置。它是一个成熟的框架，具有设计人员的支持，可将设置基础架构添加到您的项目中。

但是，它不与 Visual Studio 的导入/导出设置基础结构集成。让它工作是一个非常复杂的过程，包括将自己注册为 VSPackage、实现设置架构等...我通常发现它确实不值得运行（从未成功）

Answer 2

这是一个快速教程，可以让您了解如何简单地实现这一目标（一旦您完成了一次，它就非常简单）。

我从我的扩展中使用的代码派生出以下代码；它是用 VB.NET 编写的，但可以轻松转换为 C#。

首先，只需将此类添加到您的扩展项目中即可。它应该包含您需要存储的每个值的属性。您甚至可以将它们分类。您可以在 MSDN 上查看支持的类型（了解更多对于复杂的情况，您可以参考“自定义选项页面”，该主题涵盖 MSDN 此处）。

Imports Microsoft.VisualBasic
Imports System
Imports System.Diagnostics
Imports System.Globalization
Imports System.Runtime.InteropServices
Imports System.ComponentModel.Design
Imports Microsoft.Win32
Imports Microsoft.VisualStudio
Imports Microsoft.VisualStudio.Shell.Interop
Imports Microsoft.VisualStudio.OLE.Interop
Imports Microsoft.VisualStudio.Shell
Imports System.Threading
Imports System.Text.RegularExpressions
Imports System.ComponentModel

<ClassInterface(ClassInterfaceType.AutoDual)>
<CLSCompliant(False), ComVisible(True)>
Public Class OptionPageGrid
    Inherits DialogPage

    Private _MyBooleanSetting As Boolean = False
    <Category("The name or an alias of my extension name")>
    <DisplayName("Simple name of this setting displayed for the user")>
    <Description("Longer description of this setting")>
    Public Property MyBooleanSetting() As Boolean
        Get
            Return Me._MyBooleanSetting
        End Get
        Set(ByVal value As Boolean)
            Me._MyBooleanSetting = value
        End Set
    End Property

    Private _MyIntegerSetting As Integer = 2
    <Category("The name or an alias of my extension name")>
    <DisplayName("Simple name of this setting displayed for the user")>
    <Description("Longer description of this setting")>
    Public Property MyIntegerSetting() As Integer
        Get
            Return Me._MyIntegerSetting
        End Get
        Set(ByVal value As Integer)
            Me._MyIntegerSetting = value
        End Set
    End Property

    Private _MyStringSetting As String = "DefaultStringValue"
    <Category("The name or an alias of my extension name")>
    <DisplayName("Simple name of this setting displayed for the user")>
    <Description("Longer description of this setting")>
    Public Property MyStringSetting() As Integer
        Get
            Return Me._MyStringSetting
        End Get
        Set(ByVal value As Integer)
            Me._MyStringSetting = value
        End Set
    End Property
End Class

然后，在主包类之前添加以下属性。

<ProvideOptionPage(GetType(OptionPageGrid), "The name or an alias of my extension name", "The name of a category of settings", 0, 0, True)>
Public NotInheritable Class MyExtensionMainClass
    Inherits Package

现在，为了轻松访问设置，您可以在主包类中添加以下属性：

Protected ReadOnly Property Settings() As OptionPageGrid
    Get
        Return CType(GetDialogPage(GetType(OptionPageGrid)), OptionPageGrid)
    End Get
End Property

这使得可以使用友好的方式从类中的任何位置访问值：

If (Me.Settings.MyBooleanSetting) Then MsgBox("It works!");

Visual Studio 将负责保留设置，并且它们应该是当您使用导入/导出功能（或任何设置同步扩展，例如 这个）。