생성된 코드에 Javadoc 주석 포함

Javadoc 주석이 포함되도록 하려면, 정상적으로 코드를 생성하십시오.

이 태스크 정보

Javadoc 주석 생성은 기본적으로 Java 개발자의 IBM® Rational® Rhapsody® 프로젝트에 사용할 수 있습니다.

생성된 코드에서 모델 요소에 대해 제공한 설명을 기반으로 Javadoc 주석이 표시됩니다. 오퍼레이션에 대한 주석에는 오퍼레이션 인수에 대해 제공한 설명도 포함됩니다.

코드에 이와 같은 주석이 표시되지 않으면, 사용 중인 구성에 대한 기능 창을 열고 설정 탭에서 JavaDoc 주석 생성 선택란이 선택되어 있는지 확인하십시오. 이 옵션을 선택했는데 생성된 코드에 계속 Javadoc 주석이 표시되지 않으면, Javadoc 주석 문제점 해결에 나열된 제안사항을 읽으십시오.

이러한 기본 Javadoc 주석을 생성하는 것 외에도, Rational Rhapsody가 표준 Javadoc 태그(author, deprecated, return, see, since, version)를 포함하도록 할 수 있습니다. 이러한 Javadoc 태그를 생성된 코드에 포함하려면 다음을 수행하십시오.

프로시저

  1. 문서화할 모델 요소에 대한 기능 창을 여십시오.
  2. 태그 탭에 표시되는 다양한 태그에 대해 값을 제공하여 Javadoc 컨텐츠를 추가하십시오.
  3. 문서화할 모델 요소마다 이 프로세스를 반복하십시오.
  4. 코드를 생성하십시오.

결과

코드에 Javadoc 주석이 포함되면, 표준 Javadoc 프로세스를 사용하여 Javadoc 보고서를 생성할 수 있습니다.


피드백