sql-server - 从 SQL 脚本中提取文档字符串

Question

已结束。此问题正在寻求书籍、工具、软件库等的推荐。它不满足 Stack Overflow guidelines 。目前不接受答案。

---

我们不允许提出寻求书籍、工具、软件库等推荐的问题。您可以编辑问题，以便用事实和引文来回答。

已关闭 5 年前。

Improve this question

如何才能最好地从 T/SQL 脚本中提取文档字符串并将其呈现为用户友好的 API 文档？我了解 Doxygen、Javadocs 或 Sphinx 等工具，但似乎都不了解 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。您可以为返回值、日期和作者指定自定义部分，或者在输出中包含使用指南和代码示例。玩得开心!