[Intellij] JavaDoc 주석 + 파일 생성

IntelliJ에서 JavaDoc 설정하는 방법에 대해서 알아보자.

1. JavaDoc comment 추가

• 방법 1. 단축키 (window 기준) : ctrl+shift+alt+G

• 방법 2. 더블 shift -> create JavaDocs for all elements 실행

  

• JavaDoc 코드 적용 전

  • Main Class

    public class Main {
        
        public static void main(String[] args) {
            AddNumber addNumber = new AddNumber();
        
            System.out.println(addNumber.add(2, 6));
            System.out.println(addNumber.add(2, 3,4));
        }
        
    }
    

  • AddNumber Class

    public class AddNumber {
        
        public int add(int a , int b){
            return a+b;
        }
        
        public int add(int a, int b , int c){
            return a+b+c;
        }
    }
    

• Java doc 코드 적용 후

  • Main Class

    /**
     * The class Main.
     */
    public class Main {
        
        /**
         * The entry point of application.
         *
         * @param args the input arguments
         */
        public static void main(String[] args) {
            AddNumber addNumber = new AddNumber();
        
            System.out.println(addNumber.add(2, 6));
            System.out.println(addNumber.add(2, 3,4));
        }
        
    }
    

  • AddNumber Class

    /**
     * The class Add number.
     */
    public class AddNumber {
        
        /**
         * Add int.
         *
         * @param a the a
         * @param b the b
         * @return the int
         */
        public int add(int a , int b){
            return a+b;
        }
        
        /**
         * Add int.
         *
         * @param a the a
         * @param b the b
         * @param c the c
         * @return the int
         */
        public int add(int a, int b , int c){
            return a+b+c;
        }
    }
        
    

2. Java doc 생성

• 더블 shift + Generate JavaDoc

  

• JavaDoc 생성한 결과물을 저장할 폴더 경로 설정

  

• 정상적으로 생성된 로그 확인

• 설정 후 생성된 JavaDoc html 확인

  

  

참고

한글 지원 옵션

한글 지원을 위해선 아래 옵션을 기재해준다.

-encoding UTF-8 -charset UTF-8 -docencoding UTF-8

JavaDoc Comment 형식 수정

• Setting > Tools > JavaDoc > Templates

  JavaDoc 주석 형식을 수정하여 사용 가능하다.

  

주석 한줄로 보기

• Settings > Editor > Code Style > Java > JavaDoc

  Do not wrap one line comments 체크