Question

我想到了一个想法。是否有任何方法可以在代码注释中插入图片以帮助解释我们的代码？毕竟，一张图片胜过千言万语。

由于我使用Emacs，到目前为止是否有任何Emacs实现？

Answer 1

看一下iimage-mode：它是在文本缓冲区中显示图像的标准解决方案。

例如，给定以下文件：

/* an image is worth a thousand words:
 * <path/to/image.png>
 */
int main (int argc, char **argv) {
  return 0;
}

然后运行 M-x turn-on-iimage-mode应显示image.png代替其路径。

但是，我同意@ user4815162342的评论，您需要将图像与源文件一起分发，并记住在需要时更新它们（当它们仅为文本时，有时很难更新代码注释;它将是IMO更难更新图片评论）

Answer 2

您是在谈论ASCII图形还是实际图像？

对于ASCII艺术，可以使用M-x artist-mode来绘制简单（或非常非常简单）的图像。此外，如果您需要绘制基于ASCII的UML图表，CEDET可以为您完成。

为了插入实际图像，有一些函数，如create-image和insert-image，因此编写一个用于将图像插入注释的次要模式应该很简单。但是，我不知道任何现成的解决方案。

Answer 3

如果您还要粘贴在线图片，cacoo.el将非常有用。它缓存在线图像并明智地调整大小。因此，从第二次显示图像非常快。它也适用于本地图像。

它最初是为名为cacco的网络服务开发的，但它适用于任何在线图像。