2010-12-15 94 views
5

Existe-t-il des outils disponibles pour documenter les scripts T/SQL comme JavaDocs? Par exemple, je veux être en mesure de documenter mes scripts qui contiennent créer des déclarations comme suit:JavaDoc outil similaire pour les scripts SQL

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

Répondre

1

L'outil SQL Refactor avec l'outil SQL rapide de la porte rouge aurait peut-être ce que vous recherchez. link Je l'ai utilisé depuis longtemps pour documenter mes propres procédures stockées

+0

Merci, mais je cherchais un outil gratuit. – Behrang

+0

Désolé. Je ne suis pas au courant d'un outil gratuit qui fait cela. Cependant, les outils mentionnés ci-dessus ont des sentiers gratuits. –

3

Vous devriez essayer Natural Docs de documenter les procédures SQL. C'est open-source, très simple et bien documenté. Un exemple ressemblerait à

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

La sortie est générée en tant que HTML agréable. Vous pouvez spécifier des sections personnalisées pour les valeurs de retour, la date et l'auteur, ou inclure des directives d'utilisation et des exemples de code dans votre sortie. S'amuser!