[Javadoc] Javadoc 대상이 되는 주석 작성 방법

주석을 작성하는 방법을 확인해 보자. Java로 코멘트를 작성하는 방법과, 그 중에서도 Javadoc의 대상이 되는 주석를 작성하는 방법에 대해서 설명하겠다.

Java의 주석 작성 방법

Java 소스 코드에 주석를 작성 방법은 다음 두 가지가 있다.

블록 주석

블록 주석는 /*에서 */로 둘러싸인 부분이 모든 주석이다. 여러 행을 포함 할 수 있으며, 한 줄로도 사용할 수 있다.

/*
  주석
  주석
*/

/* 주석 */

한 줄 주석

단일 행에 주석을 다는 경우에 //도 사용할 수 있다. 이 경우 //뒤에서 주바꿈까지가 주석이다.

// 주석

Javadoc의 대상이 되는 주석 작성 방법

Javadoc를 이용하는 경우에도 Java 소스 코드에 작성하는 것과 차이가 없기 때문에 Java 규칙을 따르지만, Javadoc 문서 생성의 대상으로하는 경우에는 다음과 같이 작성한다.

/**
  주석
  주석
*/

/** 주석 */

/**에서 */까지 작성된 부분이 Javadoc의 대상이 된다.

시작이 /**이고 일반적인 주석의 작성 방법인 /*에 비해 *가 하나가 많지만, /* 이후 주석으로 *가 이어서 작성되고 있는 것과 동일하기에 Java에서의 주석인 것에는 변함이 없다. Java에서의 주석에서 특히 /**로 시작하는 것만을 대상으로 한다고 생각하면 된다.

또한 Javadoc에서는 여러 줄의 주석을 작성할 때는 각 줄 앞에 *가 작성되어 있던 경우는 제외하고 그 후에 문자열만을 주석의 대상으로 한다. 그리고 *이전에 작성된 공백이나 탭도 함께 제외된다. 따라서 Javadoc의 주석은 다음과 같은 작성 방법이 자주 사용된다.

/**
 * 주석
 * 주석
 * 주석
 */

위에 작성된 주석과 아래와 같이 작성한 주석은 동일하게 Javadoc에서 처리된다.

/**
 주석
 주석
 주석
 */

그럼 다음 페이지에서 실제로 소스 코드에 작성된 코멘트에서 문서를 생성해 보도록 하자.