Javadoc UML図の挿入

Question

画像をJavaDocに埋め込む方法はありますか？基本的に、いくつかのドキュメントにクラスの階層を説明するUMLダイアグラムを含めたいと思います。

ありがとう！

Answer 1

このセクションをご覧くださいJavadocドキュメント。Javadocに画像を埋め込む方法を説明しています。

また、記事の方法を説明していますUML図をリバースエンジニアリングし、 UMLGraph を使用してJavadocに埋め込みます。

Answer 2

はい。

ドキュメントでは、 javadocドキュメントに任意の画像を埋め込みます。

JavaソースからUMLクラス図を生成する場合は、 UMLGraphドックレットをご覧ください。 。

Answer 3

ApiViz も素晴らしいドックレットです。

Answer 4

簡単な答え：

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

Answer 5

この記事は使用方法を示していますMaven Javadocプラグインを使用したUMLGraph。

要するに：

1. GraphVizをインストールします。

   Ubuntu： apt-get graphviz4のインストール。
   Windows：ダウンロード。

2. pom.xmlを更新します。

       <plugin>
           <artifactId>maven-javadoc-plugin</artifactId>
           <version>2.7</version>
           <configuration>
               <aggregate>true</aggregate>
               <show>private</show>
               <doclet>org.umlgraph.doclet.UmlGraphDoc</doclet>
               <docletArtifact>
                   <groupId>org.umlgraph</groupId>
                   <artifactId>doclet</artifactId>
                   <version>5.1</version>
               </docletArtifact>
               <additionalparam>
                   -inferrel -attributes -types -visibility -inferdep -quiet -hide java.* -collpackages java.util.* -qualify -postfixpackage
                   -nodefontsize 9
                   -nodefontpackagesize 7
               </additionalparam>
           </configuration>
       </plugin>
   

3. mvn javadoc：javadoc を実行します。

Answer 6

yDoc はオプションです

Answer 7

この記事でその方法を説明しています。 javadocツールからアクセス可能なフォルダーに画像を配置することで実行できます。