[Java] 자바 주석 종류: Javadoc 주석(/** */)과 멀티라인 주석(/* */의 차이점

1. 자바의 주석

초보 개발자들은 // 한 줄 주석을 남발하며 한 줄 한 줄씩 주석을 다는 습관을 가진다.
나 역시 처음 프로그래밍을 배울 때 그러했다.

조금 코딩을 해 본 사람들은 /* ... */을 사용해 여러 줄을 한꺼번에 주석 처리한다.

그리고 진짜 고수들은 /** ... */ Javadoc 주석을 활용한다.
이 주석은 함수, 클래스, 메서드 등의 설명을 포함하여 자동으로 문서를 생성할 수 있도록 도와준다.

오늘은 이 세 가지 주석의 차이점과 함께, 자바에서 주석을 빠르게 다루는 단축키를 알아보겠다.

2. 단축키

자바에서 주석을 빠르게 추가하거나 제거하는 단축키는 다음과 같다.
 

2-1. 한 줄 주석 (//) 단축키

Ctrl + / (Cmd + / on macOS)
여러 줄을 선택한 후 Ctrl + /를 누르면 각 줄마다 //이 추가된다.
다시 Ctrl + /를 누르면 주석이 해제된다.

2-2. 블록 주석 (/* ... */) 단축키

Ctrl + Shift + / → 여러 줄을 /* ... */로 감싸기
Ctrl + Shift + \ → 블록 주석 제거

 

2-3. Javadoc 주석 (/** ... */) 단축키

/** 입력 후 Enter → 자동으로 Javadoc 주석 생성
Alt + Shift + J (Eclipse) → 메서드, 클래스, 변수에 Javadoc 주석 추가

 

3. 한 줄 주석

자바에서 // 한 줄 주석을 빠르게 추가하거나 제거하는 단축키는 `Ctrl + shift' 이다.
예를 들어 여러 줄을 드래그 하고 Ctrl + shift를 누르면 아래와 같이 각 줄마다 단축키가 형성된다.

// int a = 10;
// int b = 20;
// System.out.println(a + b);

 

4. 멀티라인 주석 ( /* ... */ 주석 )

/* ... */ 주석은 일반적인 멀티라인 주석으로 사용된다.
코드에 대한 간단한 설명이나 일시적인 주석 처리에 사용된다.

주석 내부에 태그나 설명이 없고, 단순히 여러 줄을 주석 처리할 때 사용된다.
Javadoc과 달리 문서화와는 관련이 없고, 그냥 코드 여러 줄을 주석 처리 하는 데 사용된다.

/*
 * 이 메서드는 두 수를 더합니다.
 * 더한 결과를 반환합니다.
 */
public int add(int a, int b) {
    return a + b;
}

 
단축키

• IntelliJ IDEA: Ctrl + Shift + / (블록 주석 시작), Ctrl + Shift + \ (블록 주석 종료)
• Eclipse: Ctrl + Shift + / (블록 주석 시작), Ctrl + Shift + \ (블록 주석 종료)

 

5. /** ... */ 주석 (Javadoc 주석)

Javadoc 주석은 클래스, 메서드, 변수 등에 대한 문서화를 위해 사용된다.
Javadoc 주석은 자동으로 문서화를 생성하는 데 사용될 수 있으며, API 문서를 작성할 때 유용하다.

/**로 시작하고 */로 끝나는 형태이다. 
Javadoc 도구에서 문서화를 생성할 수 있도록 추가적인 태그 (@param, @return, @throws 등)를 사용한다.

/**
 * 두 수를 더하는 메서드입니다.
 * 
 * @param a 첫 번째 숫자
 * @param b 두 번째 숫자
 * @return 두 수의 합
 */
public int add(int a, int b) {
    return a + b;
}

Javadoc 주석은 @param (매개변수 설명), @return (반환값 설명) 등의 태그를 사용하여 API 문서를 자동으로 생성할 수 있다.

단축키 

• IntelliJ IDEA: /**를 입력하고 Enter를 누르면 Javadoc 템플릿이 자동으로 생성됩니다.
• Eclipse: /**를 입력하고 Enter를 누르면 자동으로 Javadoc 주석이 생성됩니다.