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

Question

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

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

到目前为止，我找不到成功将真实图像插入注释的方法，而不是c＃，python或任何其他常见的编程语言或IDE。

使用将图像转换为ASCII图像的工具是一种不太精确的解决方法。

任何想法都很感激

Answer 1

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

Answer 2

对于Python，您可以使用Google Colab。 在文本块中，您可以编写如下内容：

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

示例：

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

https://marketplace.visualstudio.com/items?itemName=MsBishop.ImageComments

Answer 3

我礼貌地不同意@thekip的回复。 IDE不仅是编辑器，而且是一整套工具，谢天谢地，代码编辑器已经从旧时代演变而来。这就是为什么：

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

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

代码注释是一个在这里讨论的话题，有些人辩称，将它们保持在最低限度是遵循的方法，并指出开发人员在更改代码时通常不会维护它们。像我这样的人不同意这一点，要记住注释是代码的一部分。

并非总是所有注释都具有相同的重要性，2020年的工具应该提供比UPERCASE和一串破折号更好的东西----------

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

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

始终进行编码，就像最终维护您的代码的那个人会是一个暴力的精神病患者，知道您的住所。

约翰·伍兹

@Simon Mourier对Visual Studio的答复真是太棒了！

Answer 4

Literate编程工具以这种方式工作;您基本上使用TeX或其他东西来编写代码，然后运行预处理器，将代码片段提取到中间源文件中。 http://en.wikipedia.org/wiki/Literate_programming

Answer 5

每个SHFB项目都是文档项目中所见所有的容器。在编译时，（程序项目的“）XML文档被拉入SHFB以放入文档中。

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

问题1：

“我无法使用'image'标签从概念主题中显示图像”

1. 确保使用与此类似的正确XML标记：

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

2. 请注意，Href（上方）没有关联的文件类型， 这是因为Sandcastle想要ID 。

3. 使用默认媒体文件夹将图像添加到项目。或者，如果您愿意，您可以创建自己的文件夹，例如Images。
4. 转到图片的属性页面，将Build操作设置为图像。 当您使用“图片”标记时，SHFB仅使用属性页面中的图像ID ，如上面的HREF所示。
5. 重新编译项目并打开CHM文件，您将看到     图像。

问题2：

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

1. 在代码注释的摘要部分中，标记可能看起来像 这样：

   /// <summary>   
   /// <remarks><img src="\Images\MyImage.PNG"/></remarks>
   /// </summary>
   

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

3. 将该图像添加到SHFB后，右键单击它并将“Build Action”属性更改为内容

快乐的编码和记录！ 谢谢Eric W。

关键词： SHFB无法添加图像 Sandcastle帮助文件生成器概念主题图像 代码评论图像 CHM文件图像 如何在XML代码中添加图像注释C＃

Answer 6

我发现Jupyter Notebooks对于教学非常有价值，并将其与Python结合使用。它们使您可以结合文本，图像和代码。

Microsoft announced Jupyter Notebooks for .NET Core，现在在.NET Interactive存储库中处于预览状态。

Answer 7

我认为您使用了错误的工具来解决您的问题。 IDE是一个“开发”环境，因此完全控制样式并不是很重要。

我会使用其他东西（比如LaTeX，请参阅评论）为你演示。

Answer 8

为什么不使用像http://imgur.com这样的免费图片托管并将图片链接插入代码评论？

然后，学生唯一的问题是从任何IDE复制链接到浏览器。虽然很简单。

也许某些IDE能够“加下划线”链接，以便您可以单击它而不是复制。

Answer 9

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