如何在SQL Server中更改存储过程时添加头部注释

Question

我有一个存储过程，其中没有头部注释。 我想添加它们，但每当我尝试时，它们都不会被包括。

在SQL Server Management Studio中：

1.右键单击我的存储过程并单击修改

USE [ABigDB]
GO
/****** Object:  StoredProcedure [dbo].[spDoWork]    Script Date: 21/08/2015 14:11:45 ******/
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
ALTER PROCEDURE [dbo].[spDoWork]
      @Id uniqueidentifier,
      @Session nvarchar(50),
      @XMLData xml
WITH EXECUTE AS OWNER
AS
BEGIN
--etc etc...
END

2. 我将注释粘贴到存储过程上方并运行脚本：

-- Stored Procedure
--    Author:           Dave
--    Create date:      21/08/2015
--    Description:      Does Stuff      
--  Change history
--      07/08/2015  - Overlord - Done stuff
--      06/08/2015  - Kerrigan - Done more stuff
USE [ABigDB]
GO
/****** Object:  StoredProcedure [dbo].[spDoWork]    Script Date: 21/08/2015 14:11:45 ******/
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
ALTER PROCEDURE [dbo].[spDoWork]
      @Id uniqueidentifier,
      @Session nvarchar(50),
      @XMLData xml
WITH EXECUTE AS OWNER
AS
BEGIN
--etc etc...
END

3. 当我修改同一个存储过程时，它会显示为：

USE [ABigDB]
GO
/****** Object:  StoredProcedure [dbo].[spDoWork]    Script Date: 21/08/2015 14:11:45 ******/
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
ALTER PROCEDURE [dbo].[spDoWork]
      @Id uniqueidentifier,
      @Session nvarchar(50),
      @XMLData xml
WITH EXECUTE AS OWNER
AS
BEGIN
--etc etc...
END

那么，我该如何让评论显示在那里呢？

- GIVE-ME-CHICKEN

---

尝试将注释放在ALTER PROCEDURE下面，在AS之前。 - Sam Cohen-Devries

请在顶部添加USE <储存过程所在的数据库名称> GO，然后是您的注释 -- 储存过程 -- 作者：Dave -- 创建日期：2015年8月21日 -- 描述：做事情 -- 更改记录 -- 2015年8月7日-霸主-Done stuff -- 2015年8月6日-Kerrigan-Done more stuff，最后是储存过程 ALTER PROCEDURE [dbo].[spDoWork] @Id uniqueidentifier, @Session nvarchar(50), @XMLData xml WITH EXECUTE AS OWNER AS BEGIN --等等... END。请注意，翻译中的所有更改均旨在使文本更加通俗易懂且不改变原意。 - Abhishek

Answer 1

我通过以下方法解决了它：

USE [ABigDB]
GO
/****** Object:  StoredProcedure [dbo].[spDoWork]    Script Date: 21/08/2015 14:11:45 ******/
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO

-- Stored Procedure
--    Author:           Dave
--    Create date:      21/08/2015
--    Description:      Does Stuff      
--  Change history
--      07/08/2015  - Overlord - Done stuff
--      06/08/2015  - Kerrigan - Done more stuff

ALTER PROCEDURE [dbo].[spDoWork]
      @Id uniqueidentifier,
      @Session nvarchar(50),
      @XMLData xml
WITH EXECUTE AS OWNER
AS
BEGIN
--etc etc...
END

- GIVE-ME-CHICKEN

---

基本上这就是@Abhishek的回答——是的，你需要将你的注释标题放在ALTER/CREATE PROCEDURE语句前面。 - NateJ

Answer 2

考虑使用元数据来补充您的流程、表格、列等内容，以便进行文档记录。

查看以下内容，可帮助您审查数据库对象。 在Microsoft SQL 2000+中是否可以向表格添加描述/注释？

- Ray Porrata