我的问题可能是一个疯狂的想法，但是，当我为教育目的编写代码时，它非常有价值。
尤其是当代码与数学和物理相关时，在注释中插入的图像更加方便和清晰。
到目前为止，我找不到成功将真实图像插入评论的方法，而不是 C#、python 或任何其他常见的编程语言或 IDE。
使用将图像转换为 ASCII 图像的工具是一种解决方法，但不太精确。
感谢任何想法
【问题讨论】：
我认为您使用了错误的工具来解决您的问题。 IDE 是一个“开发”环境，因此完全控制样式并不是很重要。
我会使用其他东西（如 LaTeX，请参阅评论）为您演示。
【讨论】：
这里有一个扩展 Visual Studio 2010 编辑器的示例：Image Insertion（但它与 Visual Studio 相关联，不是通用解决方案）
【讨论】：
// <image src="a.png"/>.
文学编程工具以这种方式工作；你基本上使用 TeX 或其他东西来编写代码，然后运行一个预处理器，它将代码 sn-ps 提取到一个中间源文件中。 http://en.wikipedia.org/wiki/Literate_programming
【讨论】：
为什么不使用像http://imgur.com 这样的免费图片托管并在代码注释中插入图片链接？
那么对于学生来说，唯一的问题就是从任何 IDE 复制粘贴链接到浏览器。不过很简单。
也许某些 IDE 能够“下划线”链接，以便您可以单击它而不是复制粘贴。
【讨论】：
使用沙堡
每个 SHFB 项目都是它自己的容器，用于存放文档项目中的所有内容。编译后，将（程序项目的）XML doc 拉入 SHFB 以放入文档中。
如果要在类文档的顶部显示图像，则必须将图像添加到 SHFB 项目并从代码注释中引用该图像。见问题 2...
问题一：
“我无法使用 'image' 标签从概念主题中获取要显示的图像”
确保使用与此类似的正确 XML 标记：
<section>
<content>
<mediaLink>
<image xlink:href="MyMainImage"/>
</mediaLink>
</content>
</section>
请注意，Href（上图）没有关联的文件类型，
这是因为 Sandcastle 需要 ID。
问题2：
“我无法在编程项目中使用代码注释 XML 标记来显示图像”。
在代码注释的摘要部分，标记看起来像 这个：
/// <summary>
/// <remarks><img src="\Images\MyImage.PNG"/></remarks>
/// </summary>
请注意，src 属性确实包含文件类型。它还必须正确识别您的 SHFB 项目中用于该图像的文件夹。
将该图像添加到 SHFB 后，右键单击它并将“构建操作”属性更改为 Content
快乐的编码和记录！ 感谢 Eric W。
关键词： SHFB 无法添加图像 Sandcastle 帮助文件生成器概念性主题图像 代码注释图像 CHM 文件图像 如何在 XML 代码注释 C# 中添加图像
【讨论】：
对于 Python，您可以使用 Google Colab。 在文本块中，您可以编写如下内容：
.
对于 C# 你可以试试这个插件：
https://marketplace.visualstudio.com/items?itemName=MsBishop.ImageComments
【讨论】：
! 前缀意味着我们正在处理图像并且大多数 IDE 支持控制单击以打开外部链接。现代 IDE 应该都有这个插件！
我发现Jupyter Notebooks 对教学非常有价值，并将它们与 Python 一起使用。它们让您可以组合文本、图像和代码。
Microsoft announced Jupyter Notebooks for .NET core，现在在 .NET Interactive repo 中预览。
【讨论】：
实际上，你总是可以包含图片的链接，但不能在代码的注释中添加图片。
【讨论】：
我礼貌地不同意@thekip 的回复。 IDE 不仅仅是编辑器，而是一整套工具，谢天谢地，代码编辑器已经从旧时代演变而来。这就是为什么：
很久以前，我对用于旧 AMIGA 计算机的 AMOS 开发工具感到惊讶，它具有您现在可以在许多代码编辑器中看到的折叠/展开功能，多年来我一直在问自己为什么 Borland 和 Microsoft 工具没有有它。很明显，信息不应始终处于同一级别。
代码编辑器已经具有自动文本样式，以不同颜色查看不同类型的保留字或 cmets，允许自动缩进等等。
代码中的注释是一个正在讨论的话题，一些人辩称将它们保持在最低限度是遵循的方法，他们认为开发人员在更改代码时通常不会维护它们。像我这样的人不同意这一点，记住 cmets 是代码的一部分。
并非所有 cmets 都具有相同的重要性，2020 工具应该提供比 UPERCASE 和一堆破折号分隔符更好的东西 ----------
在 cmets 中允许不同的字体大小、粗体和斜体是“必须具备的”，我们将在以后的时间里再次使用，有时相同代码中的图像图表可以节省您在适当的项目文档中搜索的大量时间。 Google Collab 和其他 Jupyter 工具似乎终于明白了这一点。
当然，所有这些都不应该通过其他工具取代项目文档，但是，嘿，让其他人的生活更轻松。
始终编写代码，就好像最终维护您的代码的人将是一个知道您住在哪里的暴力精神病患者。
约翰·伍兹
@Simon Mourier 回复 Visual Studio，摇滚！
【讨论】：
我有同样的想法，并想检查是否有人已经分享了它。
我只是以一种方式完成的：写字板 -> 在 /* */ 之间使用图像编写代码并保存为文本文档：图像已删除。只剩下一个空的评论区。
当然，这样的编辑器缺少许多有趣的可能性。 但所需要的只是让更合适的图片包含图像。
如果涉及视觉元素，可以大大加快对代码的理解。
【讨论】：