Tutorial para la documentación del código

Visual Expert puede documentar automáticamente su código.

El resultado final es una documentación HTML muy completa, que detalla cada objeto y sus dependencias en toda su aplicación. Puede utilizarse como manual de referencia para el mantenimiento del código, para revisar el código y para la transferencia de conocimientos.

Para más detalles, puede ver los siguientes ejemplos:

¿Cómo documentar su código usando Visual Expert?

  1. Abra Su proyecto de Visual Expert y haga clic en la pestaña Documentación del menú de cinta.
    Menú documentación del código de Visual Expert
  2. "Generar ahora" lanza la generación de la documentación usando los ajustes predeterminados o la última configuración.
    Generar documentación de código en Visual Expert
  3. "Programar la documentación" permite programar la generación de la documentación.
    Programe la documentación de su código en Visual Expert

    Puede programar la documentación de forma regular (diariamente, semanalmente, mensualmente) o en un momento específico, cuando su máquina no esté ocupada.

    Gestione el programa de documentación del código utilizando Visual Expert
  4. El botón "Abrir/Ver" abre la última documentación generada.
    Vea la última documentación del código en Visual Expert
  5. Visual Expert soporta cuatro idiomas: inglés, francés, japonés y español.
    La documentación del código será generada en base a su selección de idioma.
    Seleccione entre varios idiomas para la documentación del código
  6. Por defecto, Visual Expert genera documentación de todo el proyecto.
    Las opciones de "ajustar el contenido" permiten reducir el alcance de la documentación.
    Para más detalles, vaya a: Configuración avanzada > Ajustar Contenido.
    Aplicar filtros a la documentación del código
  7. "Configuración avanzada" abre el Centro de Documentación donde puede personalizar la documentación.
    Personalizar la documentación del código con la configuración avanzada

Personalizar la documentación del código con la configuración avanzada

El Centro de Documentación está dividido en dos subsecciones:

1. Configuracion

Esta sección le permite indicar la ruta, el contenido, el estilo, la plantilla y el idioma antes de generar la documentación.

Indicar la ruta, el contenido, el estilo, la plantilla y el lenguaje para la documentación del código

RUTA PARA DOCUMENTACIÓN:

Configure una ruta desde su disco duro para guardar la documentación.
Haga clic en "Examinar carpetas" para cambiar la ruta.

ESTILO:

Visual Expert le permite crear un estilo personalizado para su documentación HTML.
Haga clic en "Editar estilos" para crear un nuevo estilo. En el menú desplegable, cambie el "Estilo predeterminado de Novalys" por su estilo personalizado.

PLANTILLA:

Seleccione la plantilla de documentación deseada, por ejemplo "Documentación de referencias" o "Revisión de código".

CONTENIDO:

Por defecto, Visual Expert genera la documentación de todo el proyecto.
Si necesita documentar sólo una parte del proyecto, puede seleccionar la opción "Sólo elementos seleccionados" en esta lista.

Crear documentación de código para elementos seleccionados de su proyecto

La documentación se generará sólo para los componentes seleccionados en la Vista Principal.

Generar documentación de códigos para elementos seleccionados de su proyecto

LENGUAJE:

Seleccione el idioma de la documentación entre estas opciones: inglés, francés, español y japonés.

AJUSTAR EL CONTENIDO:

Esta ventana permite filtrar los tipos de componentes incluidos en la documentación según su tipo.

Filtrar los componentes según su tipo en la documentación del código

Como se muestra arriba, para cada tipo de componente elegido, también puede filtrar uno o más detalles según sea necesario.
Los cambios serán guardados para todas las futuras documentaciones de este proyecto al hacer clic en 'OK'.

2. Planificador

Esta subsección le permite programar la documentación diariamente, semanalmente, mensualmente o a una hora específica.

Documentación de los códigos de programación diaria, semanal, mensual o a una hora específica

Visual Expert considera la configuración actual de la ruta, el estilo, la plantilla, el contenido y el idioma mientras genera la documentación programada.

Hay cuatro botones en la parte inferior del centro de documentación. El uso de cada uno es como se muestra a continuación:

Opciones disponibles en el centro de documentación

Página principal de un ejemplo de Documentación de Referencia creada para un proyecto de PB + SQL server

Documentación de ejemplo para el proyecto PB + SQL Server

REPORTES DE REVISIÓN DE CÓDIGO

Visual Expert también puede generar reportes de revisión de código.

Vea los siguientes ejemplos:

Para crear la documentación de revisión del código, siga los pasos que se indican a continuación:

  1. En el menú de cinta, seleccione la pestaña "Documentación" y haga clic en "Configuración avanzada" para abrir el "Centro de documentación".
    Generar el reporte de revisión del código
  2. Seleccione la plantilla "Revisión del código".
    Generar el reporte de revisión del código
  3. Haga clic en "Generar ahora" para empezar a generar la documentación de revisión del código.
    Generar el reporte de revisión del código

Ajustar el contenido

Puede filtrar el contenido de la documentación de revisión del código seleccionando sólo los tipos de componentes y las partes de la documentación requeridos. Para ello, haga clic en el botón "Ajustar el contenido" para abrir los ajustes de contenido de la documentación.

Filtrar el contenido de su documentación de revisión de código por tipo de componente

Por ejemplo, la selección siguiente sólo generará la documentación de revisión del código para los procedimientos almacenados no utilizados y no comentados.

Generar un reporte de revisión del código para los procedimientos almacenados no utilizados y no comentados

Página principal de un ejemplo de documentación de revisión de código creado para un proyecto de PB + SQL Server

Generar un reporte de revisión del código para los procedimientos almacenados no utilizados y no comentados

VEA TAMBIÉN: