sql-server - 什么是 SQL Server 的良好 XDOC（或 C# 等效）程序/插件样式？

Question

我正在寻找一种方法来正确注释我的存储过程代码，以便我可以将信息提取到有用的文档中，比如 XDOC（或 C# 等价物）。最好是轻量级的东西是理想的。

Answer 1

为什么不使用可以在简单 SQL 语句中查询的扩展属性？

SELECT * FROM sys.extended_properties

不需要任何插件、附加组件或具有特定的存储过程布局......

这是我们用于数据库中每个对象的内容（我们也使用Red Gate SQL Doc来提供一些结构和一个漂亮的网站）

Answer 2

如果您已经在使用 Sandcastle 根据 Visual Studio 生成的 XML 注释生成文档，您可能需要查看以下 CodeProject 项目：

SQL XML 文档

它向您展示了如何使用您已经在使用的工具为您的 SQL 对象生成文档，其样式与您已经为其余代码生成的文档的样式相同。