視覚的なサンプル テスト ケースを多数扱っています。それらを Java ソースに含めて Javadoc にリンクする便利な方法はありますか? (IDE で javadoc レンダラー機能を呼び出すことにより) コード中に IDE が自動的にそれらを表示できるようにしますか?
Javaソースの横に画像を置いて使ってみ<img>
たのですが、取れません(pngを使いました)。
(注 - この場合、それは私のテストソースにあります)
少し遠いですが、Base64に変換することで、ドキュメント内の画像をインライン化できます。次のようになります。
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..." />
変換を行うために利用できるオンラインツールがあります:
ソースを示さなかったので、ガラス玉の推測しかできません...
文書化の目的で必要なファイルについてはdoc-files
、パッケージ ディレクトリの名前の付いたサブディレクトリに配置する必要があります。これらは、Javadoc によって単純に出力ディレクトリにコピーされます。次に、要素で相対パスを使用し<img>
ます。
IDE の Javadoc レンダラーが同じことを行うかどうかはわかりませんが、試してみる価値はあります。
この方法を試してください
/**
* @author KamyninSA
* @version 1
* <p><b>Description</b></p>
* <p><img src="{@docRoot}/../src/test/resources/doc-files/ads.png" alt="alternative directory"></p>
* */
Paŭlo の回答を少し拡張すると、ここで Maven ビルドが JDK-8 (より厳密な HTML 検証) で機能したものであり、javadoc ツールを実行するという条件が満たされました。
残念ながら、Netbeans では、IDE の javadoc ポップアップに画像が表示されません。この netbeans バグを開いたところです。
これが com.foo.File.java の javadoc の一部であると仮定します (w3schools による正しい方法である img 終了タグがないことに注意してください)。
<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>
...