[Spring] Spring boot 프로젝트를 javadoc 문서로 만들기

 

 

 

개요

intellij에서 javadoc으로 문서를 만들어주는 기능이 있다는 것을 발견해서 프로젝트를 javadoc으로 만들어보았다!.

본론

기본적인 개념

javadoc 주석을 달아놓은 메서드와 클래스들을 문서로 자동으로 만들어준다.

    /**
     * 유저의 이메일이 데이터베이스에 존재하는지 체크
     * @param email 체크하려는 이메일
     * @return true 존재하는 이메일, false 존재하지 않는 이메일
     *
     */
    private void emailDuplicateCheck(String email){
        if(userDAO.existUserByEmail(email)){
            throw new EmailDuplicateException();
        }
    }

위와 같이 /** 내용 */ 형태로 작성한 주석을 javadoc이라 한다.

아무런 어노테이션 없이 작성한 내용은 메서드의 설명이 된다.

• @param : 파라미터 설명을 달아줄 수 있다.
• @return : 리턴 값에 대한 설명을 달아준다.

더 많은 값들은 따로 찾아보길 바란다.

위와 같이 작성한 내용은 IDE에서 설명으로도 볼 수 있다.

Intellij의 Generate javaDoc…

intellij의 메뉴중에서 tools에 가면 Generate javaDoc…버튼이 있다.

Generate javaDoc

• JavaDoc Scope : 자바 문서로 만들 패키지의 범위를 지정해준다.
  • 자신에게 맞는 것을 선택하거나 Custom scope로 자신이 지정하고 싶은 범위와 만들지 않을 범위 등을 커스터마이징 해서 선택할 수 있다.
• JavaDoc Options : 자바 문서 설정이다.
  • Include JDK and library sources in -sourcepath : 라이브러리와 JDK를 포함할 것인지 묻는 것 같은데.. 내가 할때는 저 옵션을 키면 에러가 발생해서 체크를 풀어주었다.
  • OutPut directory : 출력하고자하는 경로를 작성한다. 폴더를 만들지 않고 그냥 출력하면 폴더를 만들어주지 않기 때문에 폴더를 미리 만들고 출력하는 것을 추천한다.. ㅠㅠ
  • Visibility level : 자바 문서를 작성할 때 어느 접근지정자까지 출력할지 정한다. private로 설정하면 private 메서드와 필드까지 모두 나온다.
• Locale : ko_KR해주면 한국으로 잡힌다.
• Command line arguments : -encoding UTF-8 -charset UTF-8 -docencoding UTF-8
  • 인코딩, 디코딩 charset을 UTF-8로 설정해준다.

위와 같이 설정하고 Generate 버튼을 눌러주면 다음처럼 빌드된다!.

exit code 1이 나오면 성공이다.

index.html

index.html에 들어가면 성공적으로 나온다.

위에서 본 메서드도 잘 만들어진 것을 볼 수 있다!.

결론

자바 클래스들의 메서드들과 필드들에 대한 설명을 문서로 쉽게 만들 수 있어서 좋은 것 같다.

javadoc 주석으로 만들면 IDE에서 설명도 나오기 때문에 겸사겸사 사용하면 좋다.