JavaDoc

JavaDoc이란?

Java 소스 코드에서 HTML 형식의 API 문서를 생성하기 위한 문서 생성기입니다. (자바스크립트는 JSDoc)

작성 방법

코드에 /* ~ / 형식으로 주석을 작성해 주면 됩니다.

/**
 * 포인트 도메인 클래스
 */
@AllArgsConstructor(access = AccessLevel.PRIVATE)
public class Point {
    /**
     * 포인트 ID
     */
    private Long pointId;

    /**
     * 포인트 값
     */
    private Integer pointValue;

    /**
     * 포인트 ID 반환
     * @return 포인트 ID
     */
    public Long getPointId() {
        return pointId;
    }

    /**
     * 포인트 값 반환
     * @return 포인트 값
     */
    public Integer getPointValue() {
        return pointValue;
    }
}

@link
@see
@author
@version
@return
@param
같은 태그를 사용 가능합니다.

인텔리제이에서 javadoc 생성 방법

shift 두 번 누르고 Generate JavaDoc... 선택!

결과

이런식으로 만들어집니다.