在javadocs中包含图像

Question

我使用了很多可视化的示例测试用例。有没有方便的方法将它们包含在我的Java源代码中，并将它们链接到Javadoc中，这样我的IDE可以在编码时自动显示它们（通过在我的IDE中调用javadoc渲染器功能？）

我试图在Java源代码并使用<img>，但它没有考虑（我使用了png）。

（注 - 这是在这种情况下，我的测试源）

Answer 1

当你没有表现出任何的来源，我只能做一个玻璃球猜测...

对于它们的任何文件需要用于文档目的，您应该将它们放在您的软件包目录的名为doc-files的子目录中。这些将被Javadoc简单地复制到输出目录。然后在<img>元素中使用相对路径。

我不确定您的IDE的Javadoc渲染器是否也会这样做，但值得一试。

Answer 2

有点牵强，但您可以通过将文档中的图像转换为Base64来内联图像。它应该是这样的：

<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..." /> 

有可供执行转换在线工具：

• http://www.base64-image.de
• http://daturi.me
• http://www.freeformatter.com/base64-encoder.html

Answer 3

使用Eclipse月神以下工作为了我。

• COM
  • 公司
    • somepackage
      • DOC-文件
        • image.png
      • Test.java

现在Test.java的Javadoc：

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

与Eclipse的显示图像的双方在弹出的帮助，当你的鼠标，和在Javadoc视图。

您甚至可以将style="width: 100%;"添加到img标记，以便图像调整为视图/弹出窗口大小。

Answer 4

为了扩展Paŭlo的答案，假设这里的maven构建是JDK-8（更严格的HTML验证）对我的工作，并规定您愿意运行javadoc工具。

不幸的是，在Netbeans中，我无法在IDE的javadoc弹出窗口中看到图像，我只是打开了this netbeans bug。

假设这是Javadoc文档com.foo.File.java的一部分（注意没有IMG结束标签，这是每W3Schools的正道）：

<img src="doc-files/foo.png" alt="Foo"> 

在Maven目录结构会发现这里的形象：src/main/javadoc/com/foo/doc-files/foo.png

而在去年，在pom.xml（注意docfilessubdirs设置为true）：

<build> 
    <plugins> 
     <plugin> 
      <groupId>org.apache.maven.plugins</groupId> 
      <artifactId>maven-javadoc-plugin</artifactId> 
      <version>2.10.3</version> 
      <configuration> 
       <docfilessubdirs>true</docfilessubdirs> 
      </configuration> 
     </plugin> 
     ... 

Answer 5

我就这个问题为跌跌撞撞我也想显示我的图标预览。在阅读答案后，我还没有满意并为自己尝试。这就是我现在得到：

 /** 
    * <img src="../../../../../../resources/com/my/project/client/images/myImage.png"><br> 
    * Icon for myImage. 
    * 
    * @return the icon 
    */ 

这样我不需要通过简单地将实际的图像所在的文件夹，比以前管理更多图片