• JDK에 포함된 도구
• Java로 작성된 소스 코드의 문서화에 사용됨
  • HTML 형식으로 출력

☕ RegularPolygon.java

public class RegularPolygon {

    private int sides;

    public RegularPolygon(int sides) {
        this.sides = sides;
    }

    public double getInnerAngle () {
        return (sides % 2) * 180 / sides;
    }

    public int getPerimeter (int sideLength) {
        return sideLength * sides;
    }
}

• 클래스, 필드, 메소드 위에 /** 을 입력하고 탭을 눌러 볼 것
  • IntelliJ의 기능. 많은 IDE에서 유사한 기능들 제공
• 아래와 같이 작성해 볼 것

/**
 * 각 변의 길이가 동일한
 * 다각형을 나타내는 클래스입니다.
 */
public class RegularPolygon {

    /**
     * 변의 수입니다.
     */
    private int sides;

    /**
     * 변의 수를 인자로 받는 생성자입니다.
     *
     * @param sides 변의 수
     */
    public RegularPolygon(int sides) {
        this.sides = sides;
    }

    /**
     * 내각의 크기를 반환합니다.
     *
     * @return 내각의 크기
     */
    public double getInnerAngle () {
        return (sides % 2) * 180 / sides;
    }

    /**
     * 각 변의 길이를 받아 둘레를 반환합니다.
     *
     * @param sideLength 각 변의 길이
     * @return 둘레
     */
    public int getPerimeter (int sideLength) {
        return sideLength * sides;
    }
}

• @param : 메소드의 매개변수
• @return : 메소드의 반환값

HTML 문서로 출력

• 윈도우 :

javadoc -encoding UTF-8 -charset UTF-8 -d docs ./src/sec13/chap05/RegularPolygon.java

• 맥 :

javadoc -d docs ./src/sec13/chap05/RegularPolygon.java

☕ Person.java

/**
 * 한 사람을 나타내는 클래스입니다.
 * @author yalco
 * @version 2.0
 */
public class Person {

    /**
    * 사람의 이름입니다.
    */
    private String name;

    /**
    * 사람의 나이입니다.
    */
    private int age;

    /**
     * 이름과 나이를 받는 생성자입니다.
     * @param name  사람의 이름
     * @param age 사람의 나이
     */
    public Person(String name, int age) {
            this.name = name;
            this.age = age;
    }
}