2010-05-25 144 views
9

有没有一种方法(或编辑器)允许我从源文件(例如* .java)链接图像/文件/ http链接,有点像富文本文档?将图像添加到源代码

通过这种方式,在阅读的代码,我可以立马在所附的图像(增强注释),而不是打开浏览器等

+1

参见http://stackoverflow.com/questions/151744/do-you-use-ascii-art-to-decorate-your-code – polygenelubricants 2010-05-25 08:24:07

+0

如果你可以做到这一点(例如通过黑客javadoc采取原始图像的HTML),这是公关可靠的一个坏主意 - 如果远程资源由于某种原因变得不再可用会发生什么? – 2010-05-25 08:34:31

+0

如果我使用eclipse,那么可能有一些eclipse插件可以做的事情? @Richard那么,图像就会坐在同一个目录中的代码中。 @polygenelubricants,感谢您的链接,我总是可以将我的图像转换成ascii艺术。 – portoalet 2010-05-25 08:48:05

回答

20

的Javadoc是HTML,所以你可以插入图片有:

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

Eclipse会高高兴兴地向你展示的Javadoc视图或悬停在注释的图像。其他IDE可能也可能不这样做。

显然,你必须确保以某种方式将图像部署的javadoc ...

-2

行业标准,源代码是几乎总是只有文字(是它以ASCII或unicode编码)。你总是可以绘制一个ASCII艺术。 ;-)

+0

不一定。 Microsoft代码样式文档标准允许在文档中链接到类型等。 – Joe 2010-05-25 08:28:00

+0

好的,当然,java也是如此。但这些链接是通过javadoc标签在ascii中实现的 – 2010-05-25 11:26:05

+3

这些是标记,并且仍以纯文本形式完成。 – Santa 2010-05-25 18:37:44

4

您可以在类的Javadoc添加<img src=""><a href="">

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

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

+3

很好的例子,但可怕的艺术。这些花括号是来自地狱:-) – 2010-05-25 09:44:33

+0

你在开玩笑吗?我简直不敢相信我的眼睛。具有讽刺意味的是,这是在文件的GUI部分... +1向我展示了这件艺术杰作。 – brimborium 2012-10-24 15:04:06

2

正如许多说,你可以使用,但例如在Eclipse中encouter错误,如果你不申报“ALT”,如果你使用“自闭合”像

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

标签似乎没有得到安宁错误=)

+1

我试过'',它对我没有任何帮助。 – hasanghaforian 2015-03-22 09:39:41

+0

好吧,也许可能是Eclipse的版本(我的开普勒),不接受缺失的ALT,但使用ALT更多的SEO xP – 2015-05-26 14:19:07