JAVADOC

JAVADOC이란?

Javadoc(Java Documentation)은 Java 프로그래밍 언어에서 사용되는 주석 형식입니다.

형식

JAVADOC은 /** */ 형식으로 쓰이며, 내부에 코드에 대한 설명을 적습니다.

class에 javadoc을 적용

field에 javadoc을 적용

JAVADOC 태그 종류

@param: 메서드의 매개변수에 대한 설명
@return: 메서드의 반환값에 대한 설명
@throws 또는 @exception: 메서드에서 던질 수 있는 예외에 대한 설명
@see: 다른 클래스, 메서드, 필드, 패키지 등과 관련된 참조
@version: 클래스 또는 패키지의 버전 정보
@author: 소스 코드의 저자
@since: 클래스 또는 메서드의 도입 버전
@deprecated: 클래스, 메서드, 또는 필드가 더 이상 권장되지 않는 것을 나타내며, 대신 사용할 것을 권장하는 대안을 제공
@link 또는 @linkplain: 특정 링크를 생성하여 다른 클래스, 메서드, 필드와 연결
@code: 소스 코드 블록
@literal: 코드 내의 특정 문자열
@inheritDoc: 부모 클래스 또는 인터페이스에서 상속된 설명을 현재 클래스나 메서드에 포함시킬 때 사용

코드 예시

/**
 * 이 클래스는 사람의 정보를 저장하는 값 객체(VO)를 나타냅니다.
 */
public class Person {
    private String name;    // 사람의 이름
    private int age;        // 사람의 나이

    /**
     * 사람의 이름을 반환합니다.
     * @return 사람의 이름
     */
    public String getName() {
        return name;
    }

    /**
     * 사람의 이름을 설정합니다.
     * @param name 사람의 이름
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * 사람의 나이를 반환합니다.
     * @return 사람의 나이
     */
    public int getAge() {
        return age;
    }

    /**
     * 사람의 나이를 설정합니다.
     * @param age 사람의 나이
     */
    public void setAge(int age) {
        this.age = age;
    }

    /**
     * 이 메서드는 사람의 정보를 문자열로 표시합니다.
     * @return 사람의 정보를 나타내는 문자열
     */
    @Override
    public String toString() {
        return "Person{" +
               "name='" + name + '\'' +
               ", age=" + age +
               '}';
    }
}