可以在代码的元数据中包含图像吗？对比 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://

或

http://

url，具体取决于图像的存储方式和位置），或在外部浏览器中。

自定义工具提示！

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

SourceLinks 论坛中的

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

Flow 文档中的图像可以指定为 inline 以及 externally。

希望这有帮助！

Answer 2

我会使用 doxygen - 在源树中的某个位置创建图像并使用 doxygen 注释。您可以在源注释中嵌入

\image

命令（请参阅 docs），doxygen 将从那里生成所有 HTML 文档。我认为 doxygen 是记录代码库的一个很棒的工具，因为您可以直接从源代码中的注释生成文档并单独分发或托管 HTML。