¿Cómo ver comentarios en las tablas y las columnas de la documentación del código Oracle?

Visual Expert (VE) 2020 ahora soporta la adición de comentarios a las tablas y columnas de Oracle.
Estos comentarios son esenciales para documentar y explicar el propósito de una tabla o una columna en particular.

El parser de Visual Expert Oracle ahora los analiza también. Los comentarios se mostrarán en la interfaz de usuario de VE, así como en la documentación del código PL/SQL de Oracle.

Cheque los comentarios en la vista principal

  • Para ver los comentarios de las tablas, seleccione "Tablas" en la raíz del treeview.
    Haga clic en "Todas las tablas" en la barra de navegación.
    Los comentarios se muestran (siempre que estén disponibles) al lado de cada nombre de tabla.

    Seleccione la tabla en la raíz del treeview

  • Haga clic en una tabla en la vista principal para ver los COMENTARIOS asociados en la vista del código fuente.

    Compruebe los comentarios de la tabla en la vista de código fuente

  • Para comprobar los COMENTARIOS sobre las Columnas, seleccione una tabla y haga clic en "Columnas" en la barra de navegación.

    Revise los comentarios en las columnas

 

Cheque los comentarios en la documentación

Consulte este artículo para aprender a generar la documentación de código PL/SQL de Oracle utilizando Visual Expert.

Una vez que se haya generado la documentación, siga estos pasos:

  • Abra la Documentación del Código generada por Visual Expert.
  • En el Tablero de control, haga clic en 'Tablas' para mostrar la lista de tablas de su aplicación.

    Compruebe los comentarios en la documentación de Oracle PLSQL

  • Los comentarios de la tabla se mostrarán en la columna "Descripción".

    Compruebe los comentarios de la tabla en la documentación de Oracle PLSQL

  • Para checar los comentarios de la columna, haga clic en un nombre de tabla de la lista de tablas.
    Sus columnas aparecen en la página de detalles de la tabla, junto con los COMENTARIOS asociados en la columna "Descripción".

    Revise los comentarios de la columna en la documentación de Oracle PLSQL

 

Visual Expert 2020, Oracle, Check Comments, Code Documentation