C# 是否可以在代码注释中插入图像？

我的问题可能是一个疯狂的想法，然而，当我为教育目的编写代码时，它是非常有价值的

特别是当代码与数学和物理相关时，插入注释中的图像更方便、更清晰

直到现在，我还找不到一种方法成功地将真实图像插入到注释中，而不是C#或python或任何其他通用编程语言或IDE

使用将图像转换为ASCII图像的工具是一种解决方法，但精度较低

---

任何想法都值得赞赏

我认为你用错了解决问题的工具。IDE是一个“开发”环境，所以完全控制样式并不重要

---

我会为您的演示使用其他东西（如LaTeX，请参阅注释）。

这里有一个扩展Visual Studio 2010编辑器的示例：（但它与Visual Studio绑定，而不是通用解决方案）

有文化的编程工具就是这样工作的；基本上，您可以使用TeX或其他工具来编写代码，然后运行预处理器，将代码片段提取到中间源文件中

为什么不使用像这样的免费图像托管并插入代码注释的图像链接

那么学生唯一的问题就是从任何IDE复制粘贴到浏览器的链接。不过很容易

---

也许有些IDE可以在链接下加下划线，这样你就可以点击链接而不是复制粘贴了。

使用Sandcastle

每个SHFB项目都是文档项目中所有内容的容器。编译后，（程序项目的）XML文档将被拉入SHFB并放入文档中

如果要在类文档的顶部显示图像，必须将图像添加到SHFB项目中，并从代码注释中引用该图像。请参阅问题2

问题1:

“我无法使用'image'标记从概念主题获取要显示的图像”

确保使用正确的XML标记，如下所示：

<section>
  <content>        
    <mediaLink>
       <image xlink:href="MyMainImage"/>
    </mediaLink>
  </content>
</section>

请注意，Href（以上）没有关联的文件类型，
这是，因为Sandcastle需要ID

使用默认媒体文件夹将图像添加到项目。或者，如果需要，可以创建自己的文件夹，例如图像

转到图像的属性页，并将构建操作设置为图像。 当您使用“image”标记时，SHFB只使用属性页中的图像ID，如上面的HREF所示

重新编译项目并打开CHM文件，您将看到 形象

问题2:

“我无法在编程项目中使用代码注释XML标记来显示图像”

在代码注释的摘要部分，标记可以如下所示 这：

//
/// 
/// 

请注意，src属性不包含文件类型。它还必须正确标识SHFB项目中该图像的文件夹

将该图像添加到SHFB后，右键单击该图像，并将“构建操作”属性更改为Content

快乐的编码和文档！ 谢谢Eric W

关键词： SHFB无法添加图像 Sandcastle帮助文件生成器概念主题图像 代码注释图像 CHM文件图像

---

如何在注释Python的XML代码中添加图像可以使用Google Colab。 在文本块内，您可以编写如下内容：

![Alt text](https://someurl.com/image.png).

例如：

对于C#，您可以尝试以下插件：

我发现这对教学很有价值，并将其与Python一起使用。它们允许您将文本、图像和代码结合起来

---

Microsoft Jupyter Notebook for.NET core，现在已在repo中预览。

实际上，您可以始终包含图像链接，但不能将图像添加到代码注释中。

我礼貌地不同意@thekip reply。IDE不仅是编辑器，而且是一整套工具，谢天谢地，代码编辑器是从过去。这就是为什么：

亿万年前，我对AMOS开发工具感到惊讶，该工具适用于旧的AMIGA计算机，它具有折叠/展开功能，您现在可以在许多代码编辑器中看到，多年来，我一直在问自己，为什么Borland和Microsoft tools没有它。很明显，信息不应该总是处于同一级别

代码编辑器已经有了自动文本样式，可以看到不同颜色的不同类型的保留字或注释，允许自动缩进，等等

代码中的注释是一个正在讨论的话题，一些人认为将注释保持在最小值下是应该遵循的方法，他们认为开发人员在更改代码时通常不会维护注释。像我这样的人不同意这一点，因为注释是代码的一部分

并非所有的注释都具有相同的重要性，2020工具应该提供比超级用例和一堆破折号分隔符更好的东西----------

允许不同的字体大小，粗体和斜体在注释中是“必须具备的”，我们将在亿万年后再次拥有，有时使用相同代码的图像图可以节省您在适当的项目文档中搜索的时间。Google Collab和其他Jupyter工具似乎终于明白了这一点

当然，所有这些都不应该通过其他工具取代项目文档，但是，嘿，让其他人的生活更轻松

始终编码，就好像最终维护你的代码的人将是一个知道你住在哪里的暴力精神病患者

约翰·伍兹

---

@Simon Mourier回复Visual Studio，rocks！

格式化用于向学生演示的代码。以这种方式嵌入有用的图像。在某些场景中，需要直接向学生交付代码。Ppt、博客文章或电子邮件

![Alt text](https://someurl.com/image.png).