通过

用于发布 Visual Studio 扩展的最佳做法检查列表

  • 项目

下面是在发布 Visual Studio 扩展之前确保记住的事项列表。

以下视频介绍了最佳做法，以确保扩展是最佳扩展。

遵循线程规则

将 Microsoft.VisualStudio.SDK.Analyzers NuGet 包添加到 VSIX 项目，这有助于发现和修复线程处理上常见最佳做法的冲突。

添加高质量图标

所有扩展都应具有与之关联的图标。 确保图标是一个高质量的 .png 文件，大小 为 90x90 像素（以 96 DPI 或更高版本为单位）。 将图标添加到 VSIX 项目后，在 .vsixmanifest 文件中将其注册为图标和预览图像。

名称和说明

研究表明，具有简短和描述性名称的扩展和准确的说明更有可能由用户安装。 确保名称反映扩展的本质。 .vsixmanifest 文件中的简短说明应将预期设置为扩展的作用。 因此，简要提及它所解决的问题及其具有的主要功能。

编写良好的市场说明

这是使扩展成功时应执行的最重要操作之一。 良好的描述包括：

  • 扩展添加的 UI 的屏幕截图/动画 GIF。
  • 各个功能的详细说明。
  • 指向更多详细信息的链接（如果适用）。

添加许可证

此许可证将显示在市场、VSIX 安装程序和“扩展”和“汇报...”对话框中。 应始终指定许可证来设置用户的期望。 使用 choosealicense.com 来帮助查找适合你的许可证。 许可证对于帮助删除任何问题和歧义非常重要，这对许多 Visual Studio 用户来说非常重要。

添加隐私声明

如果扩展收集遥测等数据，或者以任何其他方式与远程终结点通信，请在说明中添加有关该数据的说明。

尽可能使用 KnownMonikers

Visual Studio 附带了 KnownMonikers 集合中提供的数千个图标。 将图标添加到命令按钮时，查看是否可以使用现有的 KnownMonikers 图标，因为它们是 Visual Studio 用户熟悉的设计语言的一部分。 下面是 KnownMonikers 的完整列表，并获取 KnownMonikers Explorer 扩展以查找适合你的方案。

使它感觉本机到 VS

遵循 Visual Studio 本身使用的相同设计模式和原则，使扩展对用户感觉自然。 它还减少了设计不善的 UI 造成的干扰。 确保所有按钮、菜单、工具栏和工具窗口在用户处于正确的上下文中才能使用它们时默认可见。 有一些经验规则要遵循：

  • 请勿添加新的顶级菜单（文件、编辑、...旁）。
  • 在它们不适用的上下文中，不应显示任何按钮、菜单和工具栏。
  • 如果需要 自动加载 （可能不是），请尽可能晚执行。
  • 使用 VisibilityConstraints 切换命令的可见性，而不是依赖于自动加载。

使用适当的版本范围

一直支持 Visual Studio 2010 版本，以确保每个人都可以使用新的扩展，这很诱人。 问题在于，通过这样做，不再可以使用扩展支持的最低版本之后引入的任何 API。 通常，这些新 API 非常重要，有助于提高扩展和 Visual Studio 本身的性能和可靠性。

下面是用于决定支持哪些版本的 Visual Studio 的建议：

  • 仅支持早期版本和当前版本的 Visual Studio - 如果可能，则不支持旧版本。
  • 例如，[16.0,)不要指定开放式版本范围。 详细了解 版本范围。