[MSSQL] 주석 처리하는 방법

주석은 코드의 가독성을 높이고, 다른 개발자나 미래의 자신이 코드의 목적이나 동작을 이해하는 데 도움을 줍니다.
Microsoft SQL Server (MSSQL)에서 주석을 처리하는 방법에는 두 가지가 있습니다.
이 글에서는 MSSQL에서 주석을 작성하는 방법을 예제와 함께 자세히 설명하겠습니다.
 
 

1. 단일 행 주석

단일 행 주석은 한 줄짜리 주석을 작성할 때 사용합니다. 주석으로 처리하고 싶은 줄 앞에 두 개의 대시(--)를 사용하면 됩니다. 이 방식은 짧은 설명이나 메모를 남길 때 유용합니다.

-- 이 코드는 단일 행 주석입니다
SELECT * FROM Customers; -- 이 쿼리는 Customers 테이블의 모든 데이터를 선택합니다

위의 예제에서 -- 다음에 작성된 내용은 SQL Server가 실행하지 않고 무시합니다.
주석은 코드의 오른쪽 끝에 위치할 수도 있고, 줄 전체를 차지할 수도 있습니다.
 
 

2. 여러 행 주석

여러 행 주석은 여러 줄에 걸쳐 주석을 작성할 때 사용합니다. 주석의 시작 부분에 /*를, 주석의 끝 부분에 */를 사용하여 주석 영역을 정의합니다. 이 방식은 긴 설명이나 여러 줄에 걸친 주석을 남길 때 유용합니다.

/*
이 코드는 여러 행 주석입니다.
여러 줄에 걸쳐 주석을 작성할 수 있습니다.
이 주석은 SQL Server에 의해 무시됩니다.
*/
SELECT * FROM Orders;

위의 예제에서 /*와 */ 사이에 작성된 내용은 SQL Server가 실행하지 않고 무시합니다.
 
 

주석 사용의 중요성

1. 가독성 향상:
   • 주석은 코드의 목적과 동작을 설명하여 다른 사람들이 코드를 이해하기 쉽게 만듭니다.
   • 특히 복잡한 쿼리나 절차를 작성할 때 주석을 추가하면, 나중에 코드를 다시 볼 때 큰 도움이 됩니다.
2. 디버깅 용이성:
   • 문제를 해결할 때 특정 코드 블록을 주석 처리하여 실행하지 않도록 할 수 있습니다. 이렇게 하면 문제의 원인을 찾기 쉬워집니다.
3. 협업 효과:
   • 여러 명의 개발자가 함께 작업할 때, 주석은 서로의 코드를 쉽게 이해하고, 불필요한 질문을 줄이는 데 도움이 됩니다.