JavaDoc类似于SQL脚本的工具

Question

是否有可用于记录JavaDocs等T / SQL脚本的工具？例如，我希望能够记录包含以下创建语句的脚本：

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

Answer 1

您应该尝试Natural Docs来记录SQL程序。它是开源的，非常直接且有很好的文档记录。一个例子看起来像

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

输出生成为漂亮的HTML。您可以为返回值，日期和作者指定自定义部分，或在输出中包含使用指南和代码示例。玩得开心！

Answer 2

SQL Refactor工具与Red gate Might中的SQL Prompt工具一起可以满足您的需求。 link 很久以前我用它来记录我自己的存储过程