제품의 이전 릴리스에서 Javadoc 정보 보존

IBM® Rational® 모델링 제품의 이전 릴리스에서 생성된 Javadoc 태그 사이에 정보를 보존하려면, Java에서 UML로 변환을 한 번 실행하여 Javadoc 정보를 UML 모델에 있는 해당 요소의 documentation 특성으로 이주하십시오.
이 태스크 정보
이전 릴리스에서는 Java™ 코드 요소에 대한 Javadoc 정보가 다음 태그 사이에 포함됩니다.
/**
 * <!-- begin-user-doc -->
 * <!-- end-user-doc -->
 */
UML에서 Java로(UML-to-Java) 변환을 실행할 때 이 태그 사이의 주석이 보호됩니다. 이 태그는 다음 Javadoc 태그로 바뀌었습니다.
/*
 * <!-- begin-UML-doc -->
 * <!-- end-UML-doc -->
 */
제품의 이전 릴리스에서 생성된 Javadoc 태그 사이에 정보를 보존하려면, Java에서 UML로 변환을 한 번 실행하여 Javadoc 정보를 UML 모델에 있는 해당 요소의 documentation 특성으로 이주하십시오.
다음에 UML에서 Java로(UML-to-Java) 변환을 실행할 때 다음 이벤트가 발생합니다.
  • @generated 태그를 포함하는 코드 요소에 대해, UML에서 Java로 변환은 원래 Javadoc 태그를 새 Javadoc 태그로 바꿉니다. 태그 사이의 정보는 Java 코드와 UML 모델 사이에 동기화됩니다.
  • @generated 태그를 포함하지 않는 코드 요소의 경우, 모델에 있는 documentation 특성에 대한 갱신사항이 Java 코드로 전달되지 않습니다.
    주: 다음 예제와 같이, 적절한 Java 코드 요소에 @generated 태그를 추가하여 Javadoc 정보와 UML documentation 특성의 동기화를 사용할 수 있습니다.
    /**
     *<!-- begin-UML-doc -->
     *<!-- end-UML-doc -->
     *@generated
     */
주: 제품의 이전 릴리스에서 생성된 Javadoc 태그를 생성하기 위해 Java Development Toolkit에서 코드 템플리트를 수정할 수 있습니다. 독립 Javadoc 정보와 UML 모델 문서를 유지보수하도록 코드 템플리트를 편집할 수 있습니다. 코드 템플리트를 편집하려면 > 환경 설정 > Java > 코드 스타일 > 코드 템플리트 > 주석을 클릭하십시오. 다음 목록에 있는 항목마다 편집을 클릭하고 템플리트 편집 창에서 원래 Javadoc 태그를 코드 주석에 추가하십시오.
  • 유형
  • 필드
  • 생성자
  • 메소드
  • Getter
  • Setter
코드 템플리트 창에서, 코드 템플리트를 편집한 후 적용 > 확인을 클릭하십시오. 다음 코드 단편은 갱신된 유형 코드 템플리트를 보여 줍니다.
/**
 * @author $(user)
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
 * $(tags)
 */
편집하는 코드 템플리트마다, 다음에 UML에서 Java로(UML-to-Java) 변환을 실행할 때 이 변환은 다음 예제와 같이 두 유형 모두의 Javadoc 태그를 생성합니다.
/**
* <!-- begin-UML-doc -->
* Comments between these tags are synchronized between the UML model and generated Java code.
* <!-- end-UML-doc -->
* <!-- begin-user-doc -->
* Comments between these tags appear only in the code.
* <!-- end-user-doc -->
* @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
	 */

피드백