티스토리 뷰

JavaDoc은 자바 소스를 문서화를 하는 방법을 말한다. 개발 표준을 잡거나 인수인계 등등의 작업을 할때 JavaDoc을 생성하여 배포하기도 한다.  어떻게 JavaDoc 을 생성하는지 살펴보자. 

/**
 * Boot Class
 * 
 * <br>
 * Copyright Oingdaddy All rights reserved.<br>
 * <br> 
 * @author oingdaddy
 * @version 1.0
 * @since 2021. 1. 25.
 *
 */
@SpringBootApplication
public class AprojectApplication {
	
    @Autowired
    private ATest aTest;
	
    /**
     * print method
     * 
     * @author oingdaddy
     * @since 2021. 1. 25.
     */
    @PostConstruct
    private void printString() {
    	System.out.println(aTest.aComponentScan());
    } 
    ... 생략...
}

JavaDoc을 생성하고자 하는 프로젝트 내에 위와 같은 클래스가 있다. 별 내용은 없고 클래스에 주석도 달려있고 메소드에도 주석이 달려 있구나 하는 정도이다. 

 

JavaDoc 생성하기

JavaDoc Export

JavaDoc을 생성하고자 하는 프로젝트를 우클릭을 하여 Export를 클릭한다. 

 

 

Export > Javadoc

Export > Javadoc 선택 > 대상 프로젝트 지정 및 destination 지정 을 하고 Finish를 누른다. 아주 간단하다. 

 

JavaDoc 생성중

Finish를 누르면 위와 같이 Console에 JavaDoc 생성에 대한 로그를 볼 수 있다. 붉은 글씨로 나오는 부분은 waning이고 JavaDoc을 생성할때 설명이 빠졌다는 메세지이다. 말그대로 warning이니 나중에 보완을 하고 당장 생성이 되는데는 문제가 없다.  

 

 

JavaDoc 생성

JavaDoc이 생성이 되면 프로젝트의 root 하위에 doc 라는 폴더로 생성이 된다. (default로 지정했을 경우) 그리고 프로젝트의 실제 경로로 들어가도 확인할 수 있다. 이중 index.html 을 눌러서 브라우저로 잘 생성이 되었는지 확인해보자. 

 

 

JavaDoc 동작 확인

모든 클래스와 모든 메소드에 대해 필요한 정보가 잘 생성이 된것을 확인할 수 있다. 

 

끝!

댓글
최근에 올라온 글
최근에 달린 댓글
«   2024/03   »
1 2
3 4 5 6 7 8 9
10 11 12 13 14 15 16
17 18 19 20 21 22 23
24 25 26 27 28 29 30
31