Preservando Informações de Javadoc de Releases Anteriores do Produto

Para preservar as informações entre as tags Javadoc que foram geradas em releases anteriores do Produtos de Modelagem do IBM® Rational, execute a transformação de Java em UML ao migrar as informações de Javadoc para a propriedade da documentação do elemento correspondente no modelo UML.
Por Que e Quando Desempenhar Esta Tarefa
Em releases anteriores, as informações de Javadoc para um elemento de código Java™ estavam contidas entre as seguintes tags:
/**
 * <!-- iniciar-doc-usuário -->
 * <!-- encerrar-doc-usuário -->
 */
Comentários entre essas tags eram protegidos quando você executada a transformação de UML-para-Java. Essas tags foram substituídas pelas seguintes tags Javadoc:
/*
 * <!-- iniciar-doc-UML -->
 * <!-- encerrar-doc-UML -->
 */
Para preservar as informações entre as tags Javadoc que foram geradas em releases anteriores do produto, execute a transformação de Java em UML ao migrar as informações de Javadoc para a propriedade da documentação do elemento correspondente no modelo UML.
Da próxima vez que a transformação de UML-para-Java for executada, os seguintes eventos ocorrerão:
  • Para elementos de código que contêm uma tag @generated, a transformação de UML em Java substitui as tags Javadoc originais pelas novas tags Javadoc. As informações entre as tags é sincronizada entre o código Java e o modelo UML.
  • Para elementos de código que não contêm uma tag @generated, as atualizações da propriedade da documentação no modelo não são propagadas para o código Java.
    Nota: Você pode ativar a sincronização das informações Javadoc e da propriedade da documentação UML incluindo uma tag @generated no elemento de código Java apropriado, como no exemplo a seguir:
    /**
     *<!-- begin-UML-doc -->
     *<!-- end-UML-doc -->
     *@generated
     */
Nota: Para gerar tags Javadoc que foram geradas em releases anteriores do produto, é possível modificar os modelos de código no Java Development Toolkit. Você pode editar os modelos de código para manter informações Javadoc e documentação do modelo UML separadas. Para editar os modelos de código, clique em Janela > Preferências > Java > Estilo de Código > Modelos de Código > Comentários. Para cada item da lista a seguir, clique em Editar e, na janela Editar Modelo, inclua as tags Javadoc originais nos comentários do código:
  • Tipos
  • Campos
  • Construtores
  • Métodos
  • Getters
  • Setters
Na janela Modelos de Código, após editar os modelos de código, clique em Aplicar > OK. O fragmento de código a seguir mostra um modelo do código Tipos atualizado:
/**
 * @author $(user)
* <!-- iniciar-doc-usuário -->
* <!-- encerrar-doc-usuário -->
 * $(tags)
 */
Para cada modelo do código editado, da próxima vez que você executar a transformação de UML-para-Java, gera ambos os tipos de tags Javadoc, como no exemplo a seguir:
/**
* <!-- iniciar-doc-UML -->
* Comments between these tags are synchronized between the UML model and generated Java code.
* <!-- encerrar-doc-UML -->
* <!-- iniciar-doc-usuário -->
* Comments between these tags appear only in the code.
* <!-- encerrar-doc-usuário -->
* @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
	 */

Feedback