Documentar elementos

www.altova.com Imprimir este apartado Página anterior Subir un nivel Página siguiente

Inicio >  Cómo modelar > Elementos >

Documentar elementos

Puede añadir comentarios de documentación a elementos de modelado de la siguiente manera:

 

Haga clic en el elemento (en el diagrama o en la ventana Estructura del modelo).
Introduzca texto en la ventana Documentación.
 

Cualquier texto de documentación se guardará junto con el proyecto.

 

Cuando se selecciona un elemento, su documentación, si es que existe, siempre está visible en la ventana Documentación. También puede mostrar la documentación como un comentario en el diagrama:

 

Haga clic con el botón derecho en el elemento del diagrama y seleccione Mostrar | Comentarios de anotación en el menú contextual.

 

Hipervínculos de la documentación

Para crear un hipervínculo dentro de la ventana Documentación, seleccione texto en la ventana, haga clic en él con el botón derecho y seleccione Insertar o editar hipervínculos en el menú contextual. El destino del hipervínculo puede ser una página web, un diagrama, un archivo u otro elemento (véase Agregar hipervínculos a elementos).

um_hyperlinks5

Panel Documentación

 

Generación de código y comentarios de la documentación

Si genera código desde diagramas de clases, cualquier comentario aplicado a clases y a sus miembros se puede exportar también al código generado. Para ello, seleccione la casilla Escribir documentación como JavaDocs (para Java) o Escribir documentación como DocComments (para C# y VB.NET) antes de generar el código de programa. Consulte también Opciones de generación de código.

 

Asimismo, si aplica ingeniería inversa al código de programa para transformarlo en un modelo, los comentarios del código se pueden importar al modelo. Para ello, seleccione la casilla JavaDocs como documentación (para Java) o DocComments como documentación (para C# y VB.NET) antes de aplicar la ingeniería inversa al código de programa. Consulte también Opciones de importación de código.

 

Nota:al importar esquemas XML, en la ventana Documentación solo se muestra la primera anotación de tipo complejo o simple.

 

Para más información sobre cómo los comentarios en el código de programa (o esquemas XML) están asignados a los comentarios de UModel, consulte las tablas de asignaciones de cada lenguaje:

 

Asignaciones C#
Asignaciones VB.NET
Asignaciones Java
Asignaciones de esquemas XML

© 2019 Altova GmbH