SQL Server - Comments
The Comments are added in a SQL Server (Transact-SQL) statement with the purpose of making the statement easier to understand. It makes the statement more readable and hence easier to update it later. Comments are ignored when the statement is executed. In SQL Server (Transact-SQL), there are two ways of putting a comment.
- Single line comment
- Multi-line comment
Consider a database table called Employee with the following records:
EmpID | Name | City | Age | Salary |
---|---|---|---|---|
1 | John | London | 25 | 3000 |
2 | Marry | New York | 24 | 2750 |
3 | Jo | Paris | 27 | 2800 |
4 | Kim | Amsterdam | 30 | 3100 |
5 | Ramesh | New Delhi | 28 | 3000 |
6 | Huang | Beijing | 28 | 2800 |
Single line Comment
It starts with -- and ends with the end of that line. Anything after -- to the end of the line is a single line comment and will be ignored when the statement is executed.
Example:
In the example below, two line comments are used. Comments are ignored when a statement is executed.
-- first line comment SELECT Name, Salary FROM Employee; -- second line comment
This will produce the result as shown below:
Name | Salary |
---|---|
John | 3000 |
Marry | 2750 |
Jo | 2800 |
Kim | 3100 |
Ramesh | 3000 |
Huang | 2800 |
Multi-line Comment
It starts with /* and ends with */. Anything between /* and */ is a block comment and will be ignored when the statement is executed.
Example:
In the below query, multi-line comments are used. When this statement is executed these block of comments will be ignored.
/* comment line 1 comment line 2 */ SELECT EmpID, Name, City /* more comments */ FROM Employee;
This result of the above query will be:
EmpID | Name | City |
---|---|---|
1 | John | London |
2 | Marry | New York |
3 | Jo | Paris |
4 | Kim | Amsterdam |
5 | Ramesh | New Delhi |
6 | Huang | Beijing |