SQL Server 주석 사용법: 한 줄 및 여러 줄 코멘트 작성 가이드

이 글에서는 SQL Server 쿼리문에서 주석(코멘트)을 사용하는 방법을 자세히 살펴보겠습니다.

주석이란?

SQL Server에서는 SQL 문장 옆에 주석을 추가할 수 있습니다. 주석은 코드에 대한 설명, 기억해 둘 내용, 추가 해석 등을 남기는 데 활용되며, 작업 화면에서 한 줄 또는 여러 줄에 걸쳐 작성할 수 있습니다. 주석은 데이터베이스 엔진에 의해 실행되지 않으므로 코드의 동작에는 어떠한 영향도 주지 않습니다.

주석 작성 문법

SQL Server에서 주석을 만들 때 사용할 수 있는 문법은 두 가지가 있습니다.

하이픈(-) 기호 사용

사용 방법은 다음과 같습니다:

-- 주석 내용

SQL Server에서 하이픈(-)으로 시작하는 주석은 반드시 문장 끝에 위치해야 하며, 주석이 끝난 후에는 반드시 줄바꿈을 해야 합니다. 즉, 이 방식은 한 줄 주석으로만 사용할 수 있습니다.

/*와 */ 기호 사용

사용 방법은 다음과 같습니다:

/* 주석 내용 */

SQL Server에서 /*로 시작하고 */로 끝나는 주석은 SQL 문장의 어느 위치든 자유롭게 사용할 수 있으며, 필요에 따라 여러 줄에 걸쳐 작성하는 것도 가능합니다.

한 줄 주석 예제

한 줄 주석은 다양한 위치에 작성할 수 있습니다. 명령문 중간에 삽입하거나 문장 끝에 붙일 수도 있고, 아예 별도의 한 줄로 작성할 수도 있습니다. 다음 예시를 통해 구체적으로 확인해 보겠습니다.

명령문 중간에 주석이 있는 경우:

SELECT /* Author: quantrimang.com */ employee_id, last_name
FROM employees;

명령문 끝에 주석이 있는 경우:

SELECT employee_id, last_name /* Author: quantrimang.com */
FROM employees;

또는 다음과 같이 하이픈 기호를 사용할 수도 있습니다:

SELECT employee_id, last_name -- Author: quantrimang.com
FROM employees;

주석이 별도의 한 줄에 위치한 경우:

SELECT employee_id, last_name
/* Author: quantrimang.com */
FROM employees;

여러 줄 주석 예제

SQL Server에서는 SQL 문장을 작성하면서 주석을 여러 줄에 걸쳐 작성할 수도 있습니다. 예시는 다음과 같습니다:

SELECT employee_id, last_name
/*
* Author: quantrimang.com
* Purpose: SQL 문장에서 여러 줄에 걸친 주석 표시하기
*/
FROM employees;

위 예제의 주석은 작업 화면에서 네 줄에 걸쳐 표시됩니다.

또는 다음과 같은 형식으로도 작성할 수 있습니다:

SELECT employee_id, last_name /* Author: quantrimang.com
Purpose: SQL 문장에서 여러 줄에 걸친 주석 표시하기 */
FROM employees;

이처럼 주석을 활용해 문장 옆에 설명을 덧붙이면 코드를 이해하고 관리하기가 훨씬 쉬워질 뿐만 아니라, 오류 수정 작업도 더 빠르고 편리하게 진행할 수 있습니다.

도움이 되었기를 바랍니다!