注释

注释是程序代码中不执行的文本字符串(也称为备注)。注释可用于对代码进行说明或暂时禁用正在进行诊断的部分 Transact-SQL 语句和批。使用注释对代码进行说明,便于将来对程序代码进行维护。注释通常用于记录程序名、作者姓名和主要代码更改的日期。注释可用于描述复杂的计算或解释编程方法。

SQL Server 支持两种类型的注释字符:

  • --(双连字符)。这些注释字符可与要执行的代码处在同一行,也可另起一行。从双连字符开始到行尾的内容均为注释。对于多行注释,必须在每个注释行的前面使用双连字符。有关如何使用注释字符的详细信息,请参阅 --(注释)(Transact-SQL)

  • /* ... /* ... */(正斜杠-星号字符对)。这些注释字符可与要执行的代码处在同一行,也可另起一行,甚至可以在可执行代码内部。开始注释对 (/*) 与结束注释对 (*/) 之间的所有内容均视为注释。对于多行注释,必须使用开始注释字符对 (/*) 来开始注释,并使用结束注释字符对 (*/) 来结束注释。有关如何使用 /* ... */ 注释字符的详细信息,请参阅 /*...*/(注释)(Transact-SQL)

注意事项

下面是有关注释的一些基本信息:

  • 可以在注释中使用所有字母数字字符或符号。虽然 SQL Server Management Studio 代码编辑器和 sqlcmd 将搜索多行注释中行内的头两个字符 GO,但是 SQL Server 将忽略注释中的所有字符。

  • 批中的注释没有最大长度限制。一条注释可以包含一行或多行。

示例

下面是一些有效注释的示例。

USE AdventureWorks2008R2;
GO
-- Single line comment.

SELECT BusinessEntityID, Title
FROM HumanResources.Employee;
GO

/* First line of a multiple-line comment.
   Second line of a multiple-line comment. */
SELECT Name, ProductNumber, Color
FROM Production.Product;
GO

-- Using a comment in a Transact-SQL statement
-- during diagnosis.
SELECT BusinessEntityID, /* FirstName, */ LastName
FROM Person.Person;

-- Using a comment after the code on a line.
USE AdventureWorks2008R2;
GO
UPDATE Production.Product
SET ListPrice = ListPrice * .9; -- Reduce price to build market share.
GO