Altova UModel 2024

Sitio web de Altova: Documentación de proyectos UML

Ejecute el comando de menú Proyecto | Generar documentación para generar documentación detallada sobre el proyecto UML en formato HTML, Microsoft Word, RTF o PDF. La documentación generada con este comando se puede modificar y utilizar sin permiso de Altova.

La documentación abarca los elementos de modelado seleccionados por el usuario en el cuadro de diálogo "Generar documentación". Además, puede generar la documentación con un diseño fijo o indicar una hoja de estilos de StyleVision (SPS) personalizada. Usar una hoja de estilos de StyleVision permite personalizar la documentación generada (véase Hojas de estilos definidas por el usuario).

También puede crear documentación parcial de elementos de modelado. Para ello, haga clic con el botón derecho en un elemento (o en varios, usando Ctrl+clic) en la Estructura del modelo y seleccione Generar documentación. Esos elementos pueden ser una carpeta, una clase, una interfaz, etc. Las opciones de documentación son las mismas en ambos casos.

Los elementos relacionados contienen hipervínculos en el resultado generado, lo que permite navegar entre componentes. Todos los hipervínculos creados de forma manual aparecen también en la documentación.

Si un proyecto contiene perfiles de UModel (como C#, Java, VB.NET, etc.), la documentación generada los incluirá si se habilita la opción Subproyectos incluidos en la pestaña Incluir (véase el apartado Documentation Generation Options).

Para generar documentación:

1.Abra un proyecto (por ejemplo C:\Usuarios\<usuario>\Documentos\Altova\UModel2024\UModelExamples\Bank_Java.ump).

2.En el menú Proyecto, haga clic en Generar Documentación.

3.Seleccione un formato de salida (HTML, RTF, PDF).

4.También puede personalizar las opciones de generación (véaseOpciones de generación de documentación).

5.Haga clic en Aceptar y escoja una carpeta de destino para que se generen los resultados.

La imagen siguiente muestra un fragmento de la documentación generada con el diseño fijo de UModel desde el archivo de proyecto Bank_Java.ump.

Como se ve en la imagen anterior, la documentación generada incluye un índice de diagramas y elementos (con enlaces) en la parte superior del archivo HTML.

La imagen siguiente muestra un fragmento de la documentación generada para la clase Account. Observe que los miembros individuales de los diagramas de clases también contienen hipervínculos a sus definiciones. Por ejemplo, al hacer clic en una propiedad u operación se llega a su definición. Las clases jerárquicas, así como el texto subrayado, también contienen hipervínculos.