Visual Studio的9个很酷的扩展规则

酷炫的Visual Studio扩展具有几个关键功能,使其与其他功能区分开。 它们看起来并且经过深思熟虑,功能可靠。 此外,他们会尽其所能,达到卓越水平,并自然地适应Visual Studio的内部功能。

为了使编写好的扩展名变得容易,我们正在与社区合作制定一个简单的清单。 您甚至可以使用GitHub问题模板 。 在本文中,我们将介绍9个很酷的扩展规则。 细节剪下。



规则


以下列表不正确。 请记住遵循所有规则以获得最佳结果。



规则1:遵守承保范围的规则


Microsoft.VisualStudio.SDK.Analyzers NuGet包添加到VSIX项目。 这将帮助您识别和解决常见的线程错误。

规则2:添加高质量图标


所有扩展名必须具有与之关联的图标。 确保该图标是高质量的.png文件,分辨率为128×128像素,DPI为96或更高。 将图标添加到VSIX项目后,将其作为图标和预览图像注册到.vsixmanifest文件中。 Visual Studio Marketplace使用较大的图标,并且在Visual Studio中显示时,您的图标将动态更改。

规则3:标题和说明


研究表明,用户更经常安装带有简短描述性名称和有关它们的精确信息的扩展。 确保名称抓住了扩展功能的本质。 .vsixmanifest文件中的描述应建立对扩展名的期望。 总而言之,简要介绍了扩展解决的问题及其关键功能。

规则4:撰写良好的市场描述


这是您成功进行扩展所必须要做的最重要的事情之一。 一个好的描述包括:

  • 扩展程序将添加的屏幕截图/ GIF
  • 详细功能说明
  • 链接到详细信息(如果需要)

规则5:标明许可


许可证显示在Marketplace,VSIX安装程序和Extensions Manager对话框中。 始终指定许可证以为用户创造期望。 考虑使用choicealicense.com查找正确的许可证。 此规则的原因是要解决任何歧义,这对于许多Visual Studio用户而言都很重要。

规则6:添加隐私权声明


如果扩展名收集数据,例如遥测,请在说明中添加有关此注释。

规则7:尽可能使用KnownMonikers


Visual Studio带有数千个可在KnownMonikers集合中使用的图标。 在向按钮添加图标时,请检查:也许您可以使用现有的KnownMonikers图标,因为它们是Visual Studio用户熟悉的设计语言的一部分。 这是KnownMonikers的完整列表 ,您还可以使用KnownMonikers Explorer扩展找到适合您脚本的扩展。

规则8:营造本机扩展感


遵循Visual Studio本身使用的相同模式和设计原则。 这使得扩展对于用户而言自然而然。 它还可以减少因用户界面设计不良而引起的干扰。 确保仅当用户在正确的上下文中使用它们时,所有按钮,菜单,工具栏和工具窗口才默认可见。 有几个规则:

  • 切勿添加新的顶层菜单(“文件”,“编辑”等旁边)
  • 在不属于它们的上下文中,任何按钮,菜单或工具栏都不应该可见。
  • 如果您需要自动加载 (很可能不需要),请尽快进行。
  • 使用VisibilityConstraints切换命令可见性,而不是依靠自动加载

规则9:使用正确的版本范围


可能不支持Visual Studio 2010之前的Visual Studio版本,以便每个人都可以使用您的新扩展。 问题是您不能再使用该扩展支持的旧版本之后引入的API。 这些新API通常很重要,有助于提高扩展程序和Visual Studio本身的性能和可靠性。

这是我们确定支持哪些版本的Visual Studio的准则:

  • 仅支持Visual Studio的先前和当前版本-如果可能,不支持旧版本
  • 不要指定可用版本的范围。 举个例子 [16.0,)。 在此处找到有关版本的更多信息。

您的意见


您如何看待这份清单? 您是否同意规则? 请在下面的评论或GitHub存储库中分享您的想法。 我希望清单可以帮助您创建很流行的扩展。

Source: https://habr.com/ru/post/zh-CN459832/


All Articles