인텔리제이에서 Javadoc 생성하기

Javadoc 이란..?

코드상의 클라스 메소드 등등 javadoc이 있는 코드를 모두 모아 HTML문서를 생성하여 documentation 페이지를 제작할 수 있다. 구글에 oracle java api 라고 치면 https://docs.oracle.com/javase/7/docs/api/ 이곳이 먼저 보일 것이다. 눈팅해보면 여러가지 클라스와 메소드들의 설명이 자세하게 써져 있는데, 이것도 하나의 javadoc으로 볼 수 있다.

 

내가 직접 javadoc을 만들어보기..!

 

먼저 메인 클라스와 참조 클라스를 만들어보았다.

public class Point {

    int a = 1;
    int b = 2;

    public Point(int a, int b) {
        this.a = a;
        this.b = b;
    }
    public Point() {
       a = 0;
       b = 0;
    }

    public int getA() {
        return a;
    }

    public void setA(int a) {
        this.a = a;
    }

    public int getB() {
        return b;
    }

    public void setB(int b) {
        this.b = b;
    }

    @Override
    public String toString() {
        return "Point{" + "a=" + a + ", b=" + b +"}";
    }
}

 

참조클라스에 javadoc을 넣었다.

package com.springpractice;
//import statement



/**
 * PointTester tests the Point class in Point.java.
 * @author gsprint
 * @version 1.0
 * @see Point
 */
public class PointTester {
    /**
     * this is the main() method for driver program
     *
     * @param args stores the incoming command lind argument for the program
     */
    public static void main(String[] args){
        Point origin = new Point();
        System.out.println(origin);
    }
}

Javadoc의 특징 

1.javadoc은 소스코드를 문서화시키는 기능이다.
2.html파일이 모아 하나의 웹사이트에 표시된다.

3.Javadoc 구성 

part 1 : 코드설명
part 2 : 태그리스트

4.메소드나 클라스 바로 위에 작성해야 한다

5.javadoc을 작동시키는 방법

shift키 두번 누르고 generate javadoc 누름

설정은 내가 원하는 대로 하면 되는거 같다.

6.output directory는 javadoc을 저장할 내 로컬파일은 넣는 곳인데 이곳도 미리 만들어 놓자

 

 

 

javadocs 완료 ~~~~