PL/SQL Developer - plsqldoc Plug-In

 

Este Plug-In permite generar documentación HTML para las funciones procedimientos, paquetes, tipos, tablas y vistas. La documentación se deriva de la definición y los comentarios de dichos objetos, del mismo modo que Javadoc lo hace con el lenguaje de programación Java.

 

El Plug-In también permite ver rápidamente documentación de los objetos desde el entorno de PL/SQL Developer con solo hacer un clic en el nombre de un objeto en un fichero de código fuente de SQL o PL/SQL, o desde el examinador de objetos. Para navegar fácilmente por la documentación se proporcionan un índice global de la documentación y vínculos dentro de cada documento HTML. El Plug-In ofrece las siguientes ventajas:

 

  • Incremento en la calidad de la documentación - Deja de ser necesario crear y mantener documentación separada para los objetos de la base de datos, siendo necesario solo escribir los comentarios apropiados para cada objeto. La generación de documentación se realiza sin esfuerzos y se asegura que la documentación siempre esté al día con los últimos desarrollos. También se asegura la coherencia de toda la documentación.

  • Incremento de la productividad - El usuario de la documentación puede localizar fácilmente un documento y sus documentos relacionados gracias a la estrecha integración con el entorno de PL/SQL Developer y a los vínculos. El autor de la documentación se beneficia por el proceso de generación.

 

Cuando se instala el Plug-In de plsqldoc aparece un nuevo elemento plsdoc en el menú herramientas que contiene todas las funciones plsqldoc para generar y visualizar la documentación. Estas funciones también están disponibles en varios menús emergentes y en la barra de herramientas principal.


.


(C) 2005 Danysoft | Tfno. +34.916 638683 | Fax. +34 916 546382 | Información válida salvo error tipográfico
Cualquier sugerencia es bien recibida por Danysoft

.