简介 编程时使用嵌入式文件注释是一种方便而有效的方法,因为这样的注释可以在内存里刷新。许多开发语言,比如Java和C#都支持这种功能。可惜,SQL Server不支持。
TSQLDoc是Windows的脚本解释器,可从Transact-SQL的存储过程中萃取相关元数据和内嵌注释。本文介绍用TSQLDoc为数据库的存储过程生成相应的XML注释文件,然后用XSLT将XML注释文件转换成HTML或其他格式文件。以下介绍它的使用和示例,可在文末附件下载示例源程序。
使用TSQLDoc TSQLDoc支持单行文件注释:
文件注释 内容 #desc 存储过程的说明 #author 作者 #version 版本 #param 参数说明
在存储过程中加入适当的注释后,TSQLDoc就能取出存储过程中的注释文本和SQL-DMO(注1)用到的数据类型与参数说明。然后由VBScript的规则表达式列出Transact-SQL代码中的注释文本。TSQLDoc将根据tsqldoc.dtd(文末下载)生成相应的XML注释文件。
脚本运行 这里使用脚本和SQL Server的Pubs数据库来做说明。先要下载文末的TSQLDoc.vbs文件,并确认你的机器满足系统要求(注2)。然后在命令行运行以下脚本程序: cscript TSQLDoc.vbs -user [your username] -pwd [your password] -db pubs -out pubs.xml
TSQLDoc将连接到本地服务器,从pubs数据库中取出相应数据建立XML文件(pubs.xml)。这个XML文件会对每个存储过程都生成一个<sp>元素,例如:
<sp name="reptq3"> <parameters> <param name="@lolimit" datatype="money" length="8" direction="in"/> <param name="@hilimit" datatype="money" length="8" direction="in"/> <param name="@type" datatype="char" length="12" direction="in"/> </parameters> </sp>
现在给数据库增加一个存储过程,加入注释(注3):
CREATE PROCEDURE DocExample (@param1 INTEGER, @param2 VARCHAR(50), @param3 DATETIME, @outparam INTEGER OUTPUT) AS
-- #author Morten Wittrock -- #version 1.0 -- #desc Created with the purpose of demonstrating TSQLDoc documentation comments
-- #param @param1 Contains an integer -- #param @param2 Contains a string -- #param @param3 Contains a date -- #param @outparam Integer output parameter
-- 本例当中没有实际操作代码
运行上述脚本程序,得到XML文件如下:
<sp name="DocExample" version="1.0"> <author>Morten Wittrock</author> <description>Created with the purpose of demonstrating TSQLDoc documentation comments</description> <parameters> <param name="@param1" datatype="int" length="4" direction="in"> <description>Contains an integer</description> </param> <param name="@param2" datatype="varchar" length="50" direction="in"> <description>Contains a string</description> </param> <param name="@param3" datatype="datetime" length="8" direction="in"> <description>Contains a date</description> </param> <param name="@outparam" datatype="int" length="4" direction="inout"> <description>Integer output parameter</description> </param> </parameters> </sp>
生成HTML文本 TSQLDoc能用XSLT将XML注释文件转换成HTML页面(或其他格式文件)。在脚本运行程序中加入相应的XSLT文件名并指定输出为HTML文件: cscript TSQLDoc.vbs -user [your username] -pwd [your password] -db pubs -xslt transform.xsl -out pubs.html
结语 TSQLDoc是对SQL Server进行文本注释的基本工具。希望大家修改并发展它的用途。我的建议如下:
增加对数据库对象的支持,而不仅仅用于存储过程和函数注释。 增加对表,列和视图的元数据注释。 增加对用户函数的注释。 对已有注释的数据库对象作出相应报告。
如在我的程序中发现问题或有其他建议,请给我来信。
Have fun!
--------------------------------------------------------------------
注1: SQL-DMO (SQL Distributed Management Objects) 是一个对象集,使SQL Server开发者能用程序处理和管理数据库。详情可参阅附件链接。
注2: 运行TSQLDoc,系统要求: Microsoft XML Core Services 4.0 VBScript version 5.0 or later SQL-DMO (安装SQL Server时自动安装)。
注3: 运行SQL Server根目录下的instpubs.sql脚本可将pubs数据库恢复原样。
http://www.sqlservercentral.com/columnists/MWittrock/TSQLDoc.vbs
http://www.sqlservercentral.com/columnists/MWittrock/tsqldoc.dtd
http://www.sqlservercentral.com/columnists/MWittrock/transform.xsl
http://www.sqlservercentral.com/articles/articleList.asp?categoryid=53

|