Javadoc UML 다이어그램 삽입

Question

JavaDoc에 이미지를 임베드 할 수있는 방법이 있습니까? 기본적으로 일부 설명서에는 클래스의 계층 구조를 설명하는 UML 다이어그램이 일부 포함됩니다.

감사합니다.

Answer 1

Javadoc 설명서의 this section을 확인하십시오.이 설명서에서는 Javadoc에 이미지를 포함하는 방법을 설명합니다.

또한 article은 UML 다이어그램을 리버스 엔지니어링하고 UMLGraph을 사용하여 Javadoc에 임베드하는 방법을 설명합니다.

Answer 2

예.

The documentation은 임의의 이미지를 javadoc 문서에 임베드하는 방법을 설명합니다.

자바 소스에서 UML 클래스 다이어그램을 생성하려면 UMLGraph doclet을 살펴보십시오.

Answer 3

이 article은 javadoc 도구에서 액세스 할 수있는 폴더에 이미지를 배치하는 방법을 설명합니다.

Answer 4

ApiViz도 멋진 도크 렛입니다.

Answer 5

yDoc는

Answer 6

This article은 메이븐의 Javadoc 플러그인 UMLGraph를 사용하는 방법을 보여줍니다 옵션입니다. 한마디로

:

1. graphviz를 설치합니다.

   우분투 : apt-get install graphviz4.
   Windows : download.

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. 런 .

Answer 7

간단한 답변 :

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