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

Question

我希望能够在我的代码中包含一个控件的屏幕截图，这样可以让我的团队中的新成员更容易识别控件，这可能吗？

也许甚至可以将网络上的图像与评论中的路径共享，然后有一个插件，当鼠标悬停在链接上时会显示图像？

编辑(更多细节):

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

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

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

另一个确定因素是所有开发人员都将使用 VS2013(目前是基础版本)，稍后可能是更新 1 或 2。

作为该项目的最初作者和高级开发人员，这些悬停/图像引用(在代码中)对我个人而言将与任何 3rd 方开发人员或任何后来加入该计划的开发人员一样有用。

再次感谢，我增加了赏金!

Answer 1

相信你可以用Whole Tomato's free SourceLinks Visual Studio extension做你想做的事——或者至少非常接近它。

内置功能:

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

您可以在如下所示的 SourceLinks 配置对话框中看到一个示例:

(来源:wholetomato.com)

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

   // Control Image: my_smart_list.jpg

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

自定义工具提示!

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

This post在 SourceLinks 论坛中通知我们 SourceLinks 期望自定义 API 扩展将工具提示值返回为 FlowDocument XAML 文本。这对我们来说是个好消息，因为 FlowDocument 可以包含 many types of elements ，包括格式化文本、超链接和图像。

Flow 文档中的图像可以同时指定 inline以及 externally .

希望这可以帮助!