JavaDoc

Java 소스코드 파일에서 문서화 주석으로 기술된 설명을 HTML 형식으로 생성해주는 도구입니다. HTML 문서로 애플리케이션의 도움말을 구성하면 가독성도 좋으며 하이퍼링크로 각 클래스로 접근할 수 있다는 장점이 있습니다.

Tags

• @author : 소스의 저자를 의미

• {@link} : 내/외부 클래스나 메서드 등을 연결할 때 사용.

• @deprecated : 더 이상 사용을 권장하지 않는 클래스, 메서드 등을 표시.

• @see : 다른 클래스나 메서드를 참고할 경우 사용. (클래스명#메서드로 메서드도 연결할 수 있음.)

  /**
  * commnet
  * @see org.springframework.transaction.annotation.Transactional
  * @see org.springframework.transaction.annotation.Transactional#isolation
  */
  

• @since : 클래스나 메서드가 무슨 버전부터 있었는지를 표시하며, API로 제공할 경우 버전에 따른 의존성을 설정하는데 필요합니다.

• {@code}

  주석 내에 HTML 요소나 다른 자바독 태그를 무시하게 하거나

  설명에 코드를 첨부할 경우 사용합니다. 개행이 필요한 경우 <pre> 태그를 함께 사용합니다.

  /**
  * commnet
  * <pre>
  * {@code
  *  int i = 0;
  *  i++;
  * }
  * </pre>
  */
  

• a 태크: HTML의 a태크를 사용하여 외부URL을 링크할 수 있습니다.

  /**
  * commnet
  * <a href="http://www.naver.com">외부링크</a>
  */
  

• @param, @return, @throws 등과 같은 키워드도 있습니다.

• JavaDoc 작성시 알아두면 좋은 것들
  • 클래스 또는 메서드를 성공적으로 사용하기 위한 전제조건을 포함(예제 코드도 좋음)
  • 클래스 또는 메서드를 사용할 때 주의할 점이 있다면 작성
  • 자세하게 명확하게 가독성있게

• Intellij에서 JavaDoc 문서 생성하기

  shift 두번을 누르고 Generate JavaDoc을 실행합니다.

  

  열린 화면에서 Output directory와 한글사용을 위해 encoding 을 입력하고 OK버튼을 누릅니다.

  

  만약 누락된 정보가 있다면 오류가 발생합니다. 오류를 더블클릭하여 이동한 다음 누락된 정보를 기입후 다시 Generate JavaDoc을 시도합니다.