可以在代码中的元数据中包含图像吗？VS 2013

Question

我希望能够在我的代码中包含控件的屏幕截图,这样可以让我的团队中的新成员更轻松地进行控件识别,这是可能的吗？

甚至可能只是让网络上的图像与评论中的路径共享,然后有一个插件,当鼠标悬停在链接上时会显示图像？

编辑(更多细节):

我正在创建一个测试项目,测试中的应用程序有超过1000个控件,其中一些在名称和用途上相似,这可能使开发人员有时难以重用我正在创建的API,因为控件名称根本就不是足以快速识别使用中的控件.

我也非常松散地使用API​​这个词,这些东西都不会在Web服务中使用,并且它将始终是包含项目引用的开发人员的白盒子,并且可以直接访问源代码.

对于我的应用程序中的每个表单(测试一个),我有一个controls.cs文件,其中列出了所测试的应用程序中该表单的所有控件 - 这是我希望悬停在控件定义中的屏幕截图能力.

另一个可靠的因素是所有开发人员都将使用VS2013(现在是基本版本),稍后可能会更新1或2.

作为该项目的初始作者和高级开发人员,这些悬停/图像引用(在代码中)对我个人而言与任何第三方开发人员或任何后来的开发人员一样有用.

再次感谢,我加了赏金!

Answer 1

我相信您可以使用Whole Tomato 的免费 SourceLinks Visual Studio 扩展来完成您想要的操作 - 或者至少非常接近它。

内置功能：

该扩展开箱即用，允许您指定希望用户能够执行操作的评论模式。指定模式后，SourceLinks 将突出显示文本编辑器中出现的所有这些模式。您将能够双击突出显示的项目并执行预先配置的操作（例如在内部/外部浏览器中打开链接，或启动可执行文件）。

您可以在 SourceLinks 配置对话框中看到如下所示的示例：
_{（来源：wholetomato.com）}

因此，您可以轻松地使用此功能来定义关键字Control Image，然后在代码中添加如下所示的注释：

   // Control Image: my_smart_list.jpg

SourceLinks 允许您双击此文本，并且您可以将其配置为在 Visual Studio 内部浏览器或外部浏览器中启动图像（使用 或file://url http://，具体取决于图像的存储方式和位置）。

自定义工具提示！

现在，如果您想为此付出更多努力并实际编写一些代码，那么 SourceLinks 允许您创建 API 扩展，以便在用户将鼠标悬停在编辑器中标记的文本上时显示自定义工具提示。SourceLinks 的默认安装附带示例 API 扩展，您可以复制这些扩展来创建您自己的扩展。有关这些示例的更多详细信息，请参阅答案顶部链接的文章。

SourceLinks 论坛中的 这篇文章告诉我们，SourceLinks 期望自定义 API 扩展以FlowDocument XAML 文本形式返回工具提示值。这对我们来说是个好消息，因为 FlowDocument 可以包含多种类型的元素，包括格式化文本、超链接和图像。

Flow 文档中的图像可以内联或外部指定。

希望这可以帮助！