Here's my dents in the universe

JavaDoc 첫 걸음


In brief,

JavaDoc은 Java 소스 코드의 주석으로부터 HTML 포맷으로 코드에 대한 문서를 생성하는 툴

How to write JavaDoc

/** 로 시작해야 함!

1. 일반 한 줄 코멘트
// 

2. 일반 여러 줄 코멘트
/* 
 * 
 */ 

3. JavaDoc!
/** 
 * 
 */

구성

JavaDoc은 코멘트block tags(@)로 구성되어 있음

/** 
 * Hero is the main entity . . . 
 * 
 * Please see the {@link com.baeldung.javadoc.Person} class\
 * @author Captain America 
 */ 
public class SuperHero extends Person { // fields and methods }

몇 가지 block tags(@)

How to generate?

JDK에 포함된 command line tool 혹은 gradle 이용해 생성 가능

$ javadoc -d doc src/*  # -d 옵션을 통해 문서 생성 위치 지정 가능

$ ./gradlew javadoc

Notable points

Reference