在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 
    */ 

這樣我不需要通過簡單地將實際的圖像所在的文件夾，比以前管理更多圖片