将图像添加到源代码中答案

【问题标题】：Adding images into source code将图像添加到源代码中
【发布时间】：2011-02-23 14:05:22
【问题描述】：

有没有一种方法（或编辑器）可以让我从源文件（例如 *.java）中链接图像/文件/http 链接，有点像富文本文档？

这样，在阅读代码时，我可以快速查看附加的图像（增加 cmets），而不是打开浏览器等。

【问题讨论】：

另见stackoverflow.com/questions/151744/…
如果你能做到（例如通过破解 javadoc 获取原始图像 html），这可能是个坏主意 - 如果远程资源由于某种原因不再可用会发生什么？
如果我使用eclipse，那么eclipse插件可能会做些什么？ @Richard 好吧，图像将正好位于同一目录中的代码旁边。 @polygenelubricants，感谢您的链接，我总是可以将我的图像转换为 ascii 艺术。
显然不需要破解javadoc，可以嵌入图像没问题。

【解决方案1】：

Javadocs 是 HTML，因此您可以在其中嵌入图像：

/**
 * This class does some funky stuff (see diagram).
 * <img src="relative/path/to/your/image.png" />
 * 
 */
 public class FunkyClass{
 }

Eclipse 会很高兴地在 javadoc 视图中或将鼠标悬停在评论上时向您显示图像。其他 IDE 可能会也可能不会这样做。

显然，您必须确保以某种方式使用 javadocs 部署图像...

【讨论】：

【解决方案2】：

您可以在类的 javadoc 中添加 <img src=""> 和 <a href="">。

您可能拥有可以轻松查看文件的 Javadoc 的工具和插件。

在 Javadoc 中混合图像和链接的一个很好的例子是 JRootPane

【讨论】：

【解决方案3】：

正如许多人所说，你可以使用，但例如在 Eclipse 中，如果你没有声明“alt”并且如果你使用像

这样的“selfclosing”标签，你会遇到错误

<img alt="image desc" src="path/img.jpg">

似乎没有给出错误 =)

【讨论】：

【解决方案4】：

按照行业标准，源代码几乎总是纯文本（以 ASCII 或 unicode 编码）。您始终可以绘制 ASCII 艺术作品。 ;-)

【讨论】：