SQL_기본_쿼리문 주석작성 요령

# 오라클에서 주석 작성하는 요령

데이터베이스 관리와 쿼리 작성 시 주석(comment)을 잘 다는 것은 코드의 가독성을 높이고, 협업 시 다른 개발자들이 코드를 이해하는 데 큰 도움을 줍니다. 이번 글에서는 오라클 데이터베이스에서 주석을 작성하는 방법과 요령을 알아보겠습니다.

## 주석 작성 방법

오라클 SQL에서 주석을 작성하는 방법은 두 가지가 있습니다: **단일 행 주석**과 **다중 행 주석**.

### 단일 행 주석

단일 행 주석은 `--` 기호를 사용하여 작성합니다. 주석 기호 뒤에 오는 모든 텍스트는 주석으로 처리되어 SQL 쿼리에 영향을 주지 않습니다.

```sql
SELECT * FROM EMPLOYEES; -- 모든 직원 정보를 선택합니다.
```

위 예제에서 `-- 모든 직원 정보를 선택합니다.` 부분이 주석입니다.

### 다중 행 주석

다중 행 주석은 `/*`로 시작하여 `*/`로 끝납니다. 이 주석은 여러 줄에 걸쳐 사용할 수 있습니다.

```sql
/*
이 쿼리는 모든 직원 정보를 선택합니다.
부서 정보와 함께 결합하여 출력됩니다.
*/
SELECT E.EMPLOYEE_ID, E.FIRST_NAME, E.LAST_NAME, D.DEPARTMENT_NAME
FROM EMPLOYEES E
JOIN DEPARTMENTS D ON E.DEPARTMENT_ID = D.DEPARTMENT_ID;
```

위 예제에서 `/*`와 `*/` 사이의 모든 텍스트가 주석으로 처리됩니다.

## 주석 작성 요령

### 1. 코드의 의도를 설명하기

주석은 코드가 **왜** 이렇게 작성되었는지를 설명하는 데 유용합니다. 코드를 읽는 사람이 코드를 이해하기 쉽게 의도를 명확히 밝히는 것이 좋습니다.

```sql
-- 매출이 10000 이상인 고객 목록을 추출합니다.
SELECT CUSTOMER_ID, CUSTOMER_NAME
FROM CUSTOMERS
WHERE SALES >= 10000;
```

### 2. 중요한 부분 강조하기

특히 중요한 쿼리 부분이나 복잡한 로직이 포함된 부분은 주석을 통해 강조할 수 있습니다.

```sql
SELECT ORDER_ID, PRODUCT_ID, QUANTITY
FROM ORDERS
WHERE ORDER_DATE = SYSDATE; -- 현재 날짜의 주문만 선택합니다.
```

### 3. 수정 사항 기록하기

쿼리에 변경 사항이 있을 경우, 주석을 통해 수정 내역과 날짜를 기록하면 좋습니다.

```sql
/*
2024-06-30: ORDER_DATE 조건을 추가하여 현재 날짜의 주문만 선택하도록 변경 (작성자: 홍길동)
*/
SELECT ORDER_ID, PRODUCT_ID, QUANTITY
FROM ORDERS
WHERE ORDER_DATE = SYSDATE;
```

### 4. 쿼리 블록 구분하기

큰 쿼리나 복잡한 스크립트의 경우, 쿼리 블록을 구분하기 위해 주석을 사용할 수 있습니다. 이렇게 하면 쿼리의 구조를 더 쉽게 파악할 수 있습니다.

```sql
-- 직원 정보와 부서 정보를 조인
SELECT E.EMPLOYEE_ID, E.FIRST_NAME, E.LAST_NAME, D.DEPARTMENT_NAME
FROM EMPLOYEES E
JOIN DEPARTMENTS D ON E.DEPARTMENT_ID = D.DEPARTMENT_ID;

-- 매출이 10000 이상인 고객 정보
SELECT CUSTOMER_ID, CUSTOMER_NAME
FROM CUSTOMERS
WHERE SALES >= 10000;
```

### 5. 쿼리 성능에 영향을 주지 않도록 주의하기

주석은 성능에 영향을 미치지 않지만, 주석 작성 시 코드의 가독성을 해치지 않도록 주의해야 합니다. 주석을 너무 많이 사용하면 코드가 복잡해 보일 수 있으므로, 필요한 경우에만 적절히 사용해야 합니다.

## 결론

주석은 코드의 가독성을 높이고, 유지보수를 쉽게 하며, 협업 시 다른 개발자들이 코드를 이해하는 데 큰 도움이 됩니다. 오라클 SQL 쿼리에서 주석을 효과적으로 사용하는 요령을 잘 익혀 더 나은 코드를 작성해보세요!