Java24 문서화 주석과 JavaDoc

문서화 주석 예시

/**
 * TriangleRU 클래스는 우상이 직각인 이등변 삼각형 클래스이다.
 * 이 클래스는 직각 이등변 삼각형을 나타내는 AbstTriangle로부터 파생된 클래스이다.
 * @author ihyeonseung
 * @see Shape
 * @see AbstTriangle*/

public class TriangleRU extends AbstTriangle {
/**
 * 우상이 직각인 이등변 삼각형을 생성한다.
 * 한 변의 길이를 인수로 받는다.
 * @param length 생성할 이등변 삼각형의 한 변의 길이
 */
    public TriangleRU(int length) {
        super(length);
    }
    /**
     * toString은 우상이 직각인 삼각형의 정보를 문자열로 반환한다.
     * @return 문자열 "TriangleLB(length:3)"을 반환한다.
     * 3부분은 길이에 해당하는 값이다.
     */

    public String toString() {
        return "TriangleRU(length:"+getLength()+")";
    }

    /** 
     * draw는 우상이 직각인 삼각형을 그린다.
     * 별표 '*'를 나열해서 그린다.
     */

    public void draw() {
        for(int i=getLength(); i>=1; i--) {
            for(int j=1; j<=getLength()-i; j++)
                System.out.print(' ');
            for(int j=1; j<=i; j++)
                System.out.print('*');
            System.out.println();
        }
    }

}

 

 

문서화 주석과 Javadoc

---

• 도형 클래스의 소스 프로그램에는 /** ... */ 형식의 문서화 주석을 활용한다.
• 문서화 주석을 사용해서 문서를 생성하는 것은 javac 컴파일러가 아닌 javadoc이라는 툴이다.
• 문서화 주석은 /와 / 사이에 기입한 주석이다. 주석을 여러줄에 걸쳐 작성하려면 다음과 같이 '*'를 시작 위치에 작성하는 것이 일반적이며, eclipse에서는 `/다음enter`키를 누르면 주석 상자가 자동으로 생성된다.

문서화 주석의 위치

---

• 문서화 주석은 클래스, 인터페이스, 생성자, 메서드, 필드의 선언 바로 앞에 작성한 것만 인식된다.
• 다음과 같이 import 주석 앞에 주석을 작성하면 클래스에 대한 주석이라고 인식하지 못하게 된다.

/** Car은 자동차를 나타내는 추상 클래스 */
import java.util.*;

class Car{
    //...
}

문서화 주석과 HTML 태그

---

주석에는 HTML 태그를 이용할 수 있다. 예를 들어 <b>와 </b>로 감싼 부분은 굵은 글씨로 표시된다.

JavaDoc 문서 생성

• Terminal을 열고, Java workspace폴더의 src 폴더의 작업중인 패키지로 이동한다.
• 다음의 명령어를 입력한다.

javadoc shape *.java

• 명령어를 실행하면 workspace 하위 폴더에 HTML file이 생성되며, 해당 클래스명.html 파일을 클릭하면 JavaDocs 문서를 볼 수 있다.