如何将图像附加到源文件?

How to attach an image to source file?

有没有一种方法或 IDE 可以将图像(或任何其他媒体)附加到源代码。这对于记录非常有用,因为它更强大地表示知识并且可以更快地理解。

您可以在 javadoc 中包含图像,Eclipse 将在弹出窗口和 javadoc 视图中显示这些图像,但不会在源代码中显示。我不知道有任何 IDE 会显示与源内联的图像。

您需要将图像文件放在 'doc-files' 文件夹中,并像普通 html 图像一样引用它:

/**
 * <img src="./doc-files/image.png" />
 */