如何在 Visual Studio 中记录数据库项目
How to document a database project in visualstudio
根据我通过 Visual studio 了解的 c# 文档,我在 Properties -> SQLCLR-Build -> XML-Documentationfile.xml 中激活了 xml 文件。
现在 xml 文件已创建,但我无法弄清楚允许使用哪些标签以及如何启动文档
在 c# 中我会这样做
/// <summary>
/// does some stuff
/// </summary>
public ....
所以我在 sql
中也做了同样的事情
--- <summary>
--- does some stuff
--- </summary>
CREATE PROCEDURE ....
但是创建的 xml 没有反映我的文档。
甚至在对 "visual studio SQLCLR build xml documentation" 进行了一些研究之后,我仍然无法找到有关 如何记录我的过程、表格和函数 的有用信息xml-文档能够捕捉到它
我正在使用 visual studio 2013 以防万一这很重要
几个想法:
- codeproject.com 上有一个名为 SQL XML Documentation 的项目,它使用 Microsoft SandCastle 从 SQL 脚本中提取 XML 评论。虽然我从未使用过它,所以我不能保证它。
- 如果您不一定需要 XML 中的文档,您可以利用 Visual Studio 的 属性 窗格中的说明 属性。该描述将作为扩展 属性 存储在 SQL 服务器中。
根据我通过 Visual studio 了解的 c# 文档,我在 Properties -> SQLCLR-Build -> XML-Documentationfile.xml 中激活了 xml 文件。
现在 xml 文件已创建,但我无法弄清楚允许使用哪些标签以及如何启动文档
在 c# 中我会这样做
/// <summary>
/// does some stuff
/// </summary>
public ....
所以我在 sql
中也做了同样的事情--- <summary>
--- does some stuff
--- </summary>
CREATE PROCEDURE ....
但是创建的 xml 没有反映我的文档。
甚至在对 "visual studio SQLCLR build xml documentation" 进行了一些研究之后,我仍然无法找到有关 如何记录我的过程、表格和函数 的有用信息xml-文档能够捕捉到它
我正在使用 visual studio 2013 以防万一这很重要
几个想法:
- codeproject.com 上有一个名为 SQL XML Documentation 的项目,它使用 Microsoft SandCastle 从 SQL 脚本中提取 XML 评论。虽然我从未使用过它,所以我不能保证它。
- 如果您不一定需要 XML 中的文档,您可以利用 Visual Studio 的 属性 窗格中的说明 属性。该描述将作为扩展 属性 存储在 SQL 服务器中。