Habilitar PLDOC dentro de la herramienta SQLDEVELOPER

Pasos para agregar la funcionalidad de PLSQLDOC al IDE SQLDEVELOPER, para la generacin de documentacin de desarrollos en este lenguaje de programacin ORACLE. Arturo Uribe Bentez arturo.uribe@multisolutions.com.mx 28/01/2013

Simplificando IT

Introduccin: En el pasado he tenido que trabajar en proyectos en donde los miembros del equipo que desarrollan la aplicacin se encuentran de manera temporal en el empleo. Por lo cual, el trabajo que ellos desempean, necesitaba de una buena documentacin para que el avance que ellos lograban se pudiera compartir de una manera eficiente con los nuevos integrantes que se integraban al proyecto, una manera de agilizar el paso de contexto entre los integrantes del equipo que emigraban y los que llegaban, fue la realizacin de APIS de documentacin de sus paquetes y funciones de cdigo PL/SQL, sin embargo, no se estandarizaba la documentacin por lo que implicaba problemas y desperdicio de tiempo realizar esta documentacin. Es por esto que nos dimos a la tarea de implementar una herramienta de documentacin de cdigo parecida al JAVADOC, que siga las mismas anotaciones en el cdigo y que nos permita generar una salida, estndar y familiar con la mayora de los desarrolladores que han utilizado JAVA. Objetivo: Prepara el IDE SQLDEVELOPER, para integrar como herramienta externa la herramienta de documentacin PLDOC, para agilizar la documentacin de los paquetes en la base de datos Oracle que se utilizan para el desarrollo de una aplicacin. Implementacin: A continuacin se presentan los pasos del procedimiento de integracin de la PLDOC en SQLDEVELOPER como herramienta externa.

Aniceto Ortega 817 Colonia del Valle Mxico D.F. 03100 arturo.uribe@multisolutions.com.mx

5530126745

Simplificando IT

SE TIENE QUE GENERAR EL SIGUIENTE DIRECTORIO C:\unitecpldoc HAY QUE DAR DE ALTA HERRAMIENTA EXTERNA CON LOS SIGUIENTES PARAMETROS "${promptl:label=OBJETOS ej SATURN.SWKIGMS}" "${promptl:label=USUARIO}" "${promptl:label=URL jdbc:oracle:thin:@10.50.75.2:1521/DEVEL.uvmnet.edu}" "${promptl:label=PASSWORD}" DE CONEXION

Aniceto Ortega 817 Colonia del Valle Mxico D.F. 03100 arturo.uribe@multisolutions.com.mx

5530126745

Simplificando IT

Aniceto Ortega 817 Colonia del Valle Mxico D.F. 03100 arturo.uribe@multisolutions.com.mx

5530126745

Simplificando IT

EJECUCION SATURN.%UTIL%

nRut$s

Usuario: saturn

url conexin; jdbc:oracle:thin:@10.50.75.2:1521/DEVEL.uvmnet.edu

Aniceto Ortega 817 Colonia del Valle Mxico D.F. 03100 arturo.uribe@multisolutions.com.mx

5530126745

Simplificando IT

Conclusiones: La utilizacin de PLDOC, para la generacin de documentacin resulta una manera prctica para el equipo de desarrollo para identificar procesos y libreras compartidas que se utilizan en el desarrollo de las aplicaciones Oracle que utilizan esta tecnologa, sin embargo es necesario que los desarrolladores adopten como una buena prctica de programacin, incluir las etiquetas que permiten que la herramienta genere las APIS para un adecuado manejo de la documentacin del cdigo que se desarrolla, el documentar nuestro cdigo facilita el paso de contexto a nuevas personas que se integren en el equipo de desarrollo, as como manejar correctamente versiones de procesos y libreras que se utilizan para generar el nuevo aplicativo.

Aniceto Ortega 817 Colonia del Valle Mxico D.F. 03100 arturo.uribe@multisolutions.com.mx

5530126745