javadoc을 이용한 자바 문서화 작업

자바 클래스의 문서화 작업을 위해 javadoc이라는 명령어를 사용한다.

 

문서화할 자바 클래스 작성

 

------------------------

클래스명 : CommentEx.java

 

/**
 <font color="gray" size="4">
  "Hello World!"
 </font>
 자바에서 출력할 때 System.out.println() 사용합니다!
*/
public class CommentEx{
 public static void main(String[] args){
  
  // 한 줄  주석
  System.out.println("Hello World!");
  /*
  여러줄
  주석
    */
 }
}

------------------------

 1. cmd 모드에서 javadoc 수행

 

1) cmd 모드에서 javadoc CommentEx.java  수행

 

 

2) CommentEx.java  가 있는 폴더에서 index.html 실행

 

------------------------------

2. eclipse에서 javadoc 사용 문서화

 

1) CommentEx.java 작성

 

 

 2) Project 메뉴 > Generate javadoc 선택

 

3) 전체 파일을 문서화할지 개별 파일을 문서화 할지 선택

 

4) 옵션을 선택함, 기본 사항을 유지할 경우 next 클릭

 

 

5) 옵션을 선택함, 기본 사항을 유지할 경우 finish 클릭

 

6)  Yes To All 클릭

 

 7) doc 폴더에 html 파일들이 만들어진다. index.html를 구동하면 문서를 볼 수 있음