出色的Visual Studio扩展共享一些关键功能,这些功能使它们与众不同。 它们的外观和手感精湛,性能可靠,可以做广告宣传至完美,并自然地融入Visual Studio自身的功能中。
为了使编写出色的扩展更加容易,我们与可扩展性社区合作,提出了一个简单的检查清单。 您甚至可以使用
GitHub问题模板 ,因此您记得要仔细检查清单。

规则
以下列表没有特定顺序。 记住要完成所有项目以获得最佳结果。

规则1:遵守线程规则
将
Microsoft.VisualStudio.SDK.Analyzers NuGet包添加到VSIX项目。 这将帮助您发现并修复有关线程的最佳实践的常见违规行为。
规则2:添加高质量图标
所有扩展名都应具有与其关联的图标。 确保该图标是96 DPI或更高尺寸的高质量.png文件,大小为128×128像素。 将图标添加到VSIX项目后,将其注册为.vsixmanifest文件中的图标和预览图像。 Visual Studio Marketplace使用了较大的图标,当在Visual Studio中显示时,它将动态调整大小。
规则3:名称和说明
研究表明,用户更有可能安装带有简短描述性名称和准确描述的扩展程序。 确保名称反映了扩展名的本质。 .vsixmanifest文件中的描述应设置有关扩展名的期望。 因此,简短介绍其解决的问题以及其主要功能是关键。
规则4:撰写良好的市场描述
这是使扩展成功的最重要的事情之一。 一个好的描述包括:
- 扩展程序添加的UI的屏幕截图/ GIF动画
- 各个功能的详细说明
- 链接到更多详细信息(如果适用)
规则5:添加许可证
该许可证在Marketplace,VSIX安装程序和Extensions Manager对话框中可见。 始终指定许可证以设置对用户的期望。 考虑使用
choicealicense.com帮助您找到合适的许可证。 此规则的原因是消除任何歧义,这对于许多Visual Studio用户而言都很重要。
规则6:添加隐私声明
如果扩展名收集遥测等数据或与远程端点进行通信,请在说明中添加有关该注释的注释。
规则7:尽可能使用KnownMonikers
Visual Studio附带了数千个图标,可在
KnownMonikers集合中使用。 将图标添加到命令按钮时,请查看是否可以使用现有的KnownMonikers图标,因为它们是Visual Studio用户熟悉的设计语言的一部分。 这
是KnownMonikers的完整
列表,并获取
KnownMonikers Explorer扩展,以找到适合您的方案的扩展程序。
规则8:让VS具有原生感
遵循Visual Studio本身使用的相同设计模式和原则。 这使扩展对于用户而言自然而然。 它还可以减少因UI设计不良而引起的干扰。 确保仅在用户处于正确的上下文中使用它们时,默认情况下才可见所有按钮,菜单,工具栏和工具窗口。 需要遵循一些经验法则:
规则9:使用正确的版本范围
一直支持从Visual Studio 2010开始一直支持Visual Studio版本,以确保每个人都可以使用您的新扩展。 这样做的问题是,这样做将无法再使用比扩展支持的最低版本晚的API。 这些新的API通常很重要,有助于提高扩展以及Visual Studio本身的性能和可靠性。
以下是我们的建议,用于确定要支持的Visual Studio版本:
- 仅支持Visual Studio的先前版本和当前版本-如果可能,不支持旧版本
- 不要指定开放式版本范围。 例如[16.0,)。 了解有关版本范围的更多信息。
你的想法
您如何看待这份清单? 您是否同意规则? 请在下面的评论中或
清单的
GitHub存储库中告诉我们您的想法。 我希望这可以使您的扩展程序少一点额外的东西,使其与众不同。