2010-12-15 16 views
5

¿Hay alguna herramienta disponible para documentar scripts T/SQL como JavaDocs? Por ejemplo, quiero ser capaz de documentar mis guiones que contienen crear declaraciones como sigue:herramienta similar a JavaDoc para scripts SQL

/** 
* This is a stored procedure. 
* 
* @param foo foo does bar 
*/ 
create procedure my_proc(foo varchar(100) 
... 
GO 

Respuesta

1

La herramienta SQL Refactor junto con la herramienta SQL Prompt de la puerta rojo podrían tener lo que busca. link lo he utilizado hace mucho tiempo para documentar mis propios procedimientos almacenados

+0

Gracias, pero estaba buscando una herramienta gratuita. – Behrang

+0

Lo siento. No estoy al tanto de una herramienta gratuita que hace esto. Sin embargo, las herramientas mencionadas anteriormente tienen caminos libres. –

3

Usted debe tratar de documentar Natural Docs-SQL procedimientos. Es de código abierto, muy sencillo y está bien documentado. Un ejemplo se vería como

/** 
* This is a stored procedure. 
* 
* Parameters: 
* foo - foo does bar 
*/ 
create procedure my_proc(foo varchar(100) 
... 
GO 

El resultado se genera con un aspecto agradable de HTML. Puede especificar secciones personalizadas para valores de retorno, fecha y autor, o incluir pautas de uso y ejemplos de código en su resultado. ¡Que te diviertas!

Cuestiones relacionadas