SQL_기본_쿼리문 작성시 올바른 주석 첨부하는 법

오라클 SQL 주석 작성 방법 및 예시

데이터베이스 쿼리를 작성할 때, 주석을 활용하는 것은 매우 중요합니다. 주석은 쿼리의 의도와 동작을 명확히 설명하여 다른 개발자나 본인이 나중에 다시 봤을 때 쉽게 이해할 수 있도록 도와줍니다. 이번 글에서는 오라클 SQL에서 주석을 작성하는 방법과 주석을 사용하여 가독성을 높이는 예시를 살펴보겠습니다.

주석 작성 방법

오라클 SQL에서는 두 가지 방식으로 주석을 작성할 수 있습니다:

1. 한 줄 주석 (Single-line comment): `--` 기호를 사용하여 한 줄 주석을 작성합니다.
2. 여러 줄 주석 (Multi-line comment): `/* ... */` 사이에 여러 줄 주석을 작성할 수 있습니다.

한 줄 주석 예시

다음은 한 줄 주석을 활용한 SQL 쿼리 예시입니다:


-- 1. 데이터베이스에서 직원 테이블에서 특정 조건을 만족하는 레코드를 선택하는 쿼리입니다.
-- 2. 사용된 테이블: employees
-- 3. 필터링 조건: 급여가 5000 이상인 직원
-- 4. 출력 컬럼: 직원 ID, 이름, 직책, 급여

-- 필요한 컬럼들을 선택
SELECT
    employee_id,  -- 직원 ID
    first_name,   -- 직원의 이름
    last_name,    -- 직원의 성
    job_id,       -- 직책 ID
    salary        -- 급여
FROM
    employees
WHERE
    salary >= 5000  -- 급여가 5000 이상인 직원들을 필터링
ORDER BY
    salary DESC;  -- 급여를 기준으로 내림차순 정렬


이 예시에서는 각 주요 부분에 대해 주석을 추가하여 쿼리가 수행하는 작업을 명확히 설명하고 있습니다.

여러 줄 주석 예시

다음은 여러 줄 주석을 활용한 SQL 쿼리 예시입니다:


/*
  이 쿼리는 직원 테이블에서 특정 조건을 만족하는
  레코드를 선택하는 쿼리입니다.
  - 사용된 테이블: employees
  - 필터링 조건: 급여가 5000 이상인 직원
  - 출력 컬럼: 직원 ID, 이름, 직책, 급여
  작성자: 홍길동
  작성일: 2024-08-07
*/

SELECT
    employee_id,  /* 직원 ID */
    first_name,   /* 직원의 이름 */
    last_name,    /* 직원의 성 */
    job_id,       /* 직책 ID */
    salary        /* 급여 */
FROM
    employees
WHERE
    salary >= 5000  /* 급여가 5000 이상인 직원들을 필터링 */
ORDER BY
    salary DESC;  /* 급여를 기준으로 내림차순 정렬 */


여러 줄 주석은 쿼리의 전체적인 설명을 작성할 때 유용합니다. 주석 블록 내에 쿼리의 목적, 사용된 테이블 및 컬럼, 작성자 정보 등을 포함할 수 있습니다.

주석 작성 시 유의사항

1. 명확성: 주석은 쿼리의 의도와 로직을 명확하게 설명해야 합니다.
2. 간결성: 주석은 필요한 정보를 담되, 과도하게 길지 않도록 합니다.
3. 일관성: 주석 작성 스타일을 일관되게 유지하여 가독성을 높입니다.
4. 업데이트: 쿼리 수정 시 주석도 함께 업데이트하여 실제 코드와 주석이 일치하도록 합니다.

주석을 효과적으로 사용하면 쿼리의 가독성과 유지보수성이 크게 향상됩니다. 다른 개발자나 본인이 나중에 다시 코드를 볼 때 쿼리의 동작을 쉽게 이해할 수 있어 협업과 유지보수가 용이해집니다. 주석을 적극적으로 활용하여 더 나은 코드를 작성해 보세요!