Description 을 사용하자

전통적인 JavaDoc 은 아래와 같습니다.

/**
 * Javadoc 테스트용 클래스
 *
 * @author aimyon
 * @version 1.0
 */
@JobScope
@Component
public class DemoParameter {

    /**
     * 버전
     */
    @Value("#{jobParameters[version]}")
    private String version;

    /**
     * 버전 반환
     *
     * @return 버전
     */
    public long getVersion() {
        return Long.parseLong(version);
    }
}

Description 를 활용하면 다음과 같이 작성할 수 있습니다.

@Description("테스트용 클래스")
@JobScope
@Component
public class DemoParameter {

    //버전
    @Value(value = "#{jobParameters[version]}")
    private String version;

    @Description("버전반환")
    public long getVersion() {
        return Long.parseLong(version);
    }
}

Description을 활용하면 미리보기로 빠르게 빈을 파악할 수 있습니다.