JavaDoc 참고 내용

주석문을 잘 작성하는 방법은?

• 주석문이 없어도 이해할 수 있도록 클래스, 메소드, 변수 이름을 작성한다
• 주석문은 최소한으로 작성한다
• JavaDoc 주석문을 잘 작성한다(클래스 설명, 메소드 설명)

 

JavaDoc 주석문에서 사용하는 태그들

annotation	설명
@version	클래스나 메소드의 버전
@author	작성자
@deprecated	더이상 사용되지 않거나, 삭제될 예정
@since	언제 생성, 추가, 수정되었는가?
@see	외부 링크나 텍스트, 다른 필드나 메소드를 링크할 때 사용
@link	see와 동일한 기능. 링크 제공
@exception	발생할 수 있는 Exception 정의

 

예시

 

/**
 * ObjectBox를 담기 위한 클래스
 * 
 * @author amung(<a href="mailto:email@email.com">amung</a>
 * @since 2024.06
 * @version 0.1
 */
public class ObjectBox {

 

InteliJ에서 JavaDoc 사용하기

Shift 키 두번 연속 누르기 (메뉴 찾기)

"Generate JavaDoc" 입력

 

어떤 클래스나 어떤 패키지를 JavaDoc으로 만들건지 선택

... 누름

+ 버튼을 눌러서 파일 추가 가능

Pattern에 src:<클래스이름>* 라고 하면 작성한 클래스이름으로 시작하는 파일들을 선택할 수 있다. 

파일 선택 후 [Include] 버튼을 눌러주어야 한다.

 

JavaDoc이 생성될 위치를 Output directory에서 선택해준다 

어노테이션을 선택해서 JavaDoc에 반영할 수 있다

 

[Generate] 버튼을 누르면 아래 처럼 파일이 만들어진다.