디렉티브 주석

예동·2024년 7월 15일

노트

목록 보기

10/10

<!--@include /path/to/file.html-->
<!--@js(/path/to/file.js)-->

위의 주석의 이름은 디렉티브 주석, 또는 매직 주석

디렉티브 주석은 빌드 도구, 템플릿 엔진, 서버 사이드 랜더링 시스템에서 사용되며
특정 작업을 수행하도록 지시함
예를 들어, js 파일을 포함시키거나 특정 설정을 적용하는 등의 역할을 함

❗️ 디렉티브 주석을 사용할 때는 골뱅이(@) 앞에 띄어쓰기를 하지 않는 것이 중요 ❗️
띄어쓰기가 있으면 디렉티브가 인식되지 않거나 무시될 가능성이 높음

~~주석은 단순히 코드를 숨기기 위함이 아니며 각자의 역할을 수행중~~

주석의 종류

1. 일반 주석

코드를 설명하기 위해 사용

// 단일행 주석
/*
 *	다중행 주석
 */

2. 문서화 주석

코드의 특정 부분에 대한 문서화를 자동으로 생성하기 위해 사용
이 주석은 함수, 클래스, 변수 등에 대한 설명을 포함하며, 문서 생성 도구에 의해 파싱됨

JSDoc

/**
 * 함수 설명
 * @param {number} a 첫 번째 매개변수
 * @param {number} b 두 번째 매개변수
 * @returns {number} 두 매개변수의 합
 */
function add(a, b) {
    return a + b;
}

JavaDoc

/**
 * 함수 설명
 * @param a 첫 번째 매개변수
 * @param b 두 번째 매개변수
 * @return 두 매개변수의 합
 */
public int add(int a, int b) {
    return a + b;
}

3. 디렉티브 주석 (매직 주석)

빌드 도구나 템플릿 엔진에 특정 작업을 지시하기 위해 사용
코드의 일부가 어떻게 처리되어야 하는지 또는 특정 파일을 포함하거나 제외하는 방법을 지시함

<!--@include /path/to/file.html-->
<!--@js(/path/to/file.js)-->

4. 조건부 주석

조건부 주석은 특정 조건이 충족될 때만 코드가 실행되도록 하는 주석
주로 구형 브라우저에서 사용

Internet Explorer 조건부 주석

<!--[if IE]>
  <p>이 문장은 IE에서만 보입니다.</p>
<![endif]-->

5. 주석 아웃 (Comment Out)

코드의 특정 부분을 일시적으로 비활성화하기 위해 사용
코드의 테스트나 디버깅 과정에서 주로 사용함

// console.log("이 코드는 실행되지 않습니다.");

언니 일 도와주는데 디렉티브 주석 몰라서 애먹었다
그냥.. 안 쓰는 코드 주석 쳐놓은 줄..

예동