[Java] 주석의 종류 (구현 주석, 문서화 주석)

💡 주석이란?

주석은 코드에 대한 설명을 작성하기 위한 용도로, 프로그램의 실행에는 영향을 주지 않습니다.
가독성을 높이고, 협업 시 의도를 명확하게 전달하거나 문서를 생성하는 데 사용됩니다.

---

📝 주석의 종류

1. 구현 주석 (Implementation Comment)

코드의 흐름을 이해하기 쉽도록 설명을 덧붙이는 주석으로, 두 가지 방식이 있습니다.

 

📌 행 단위 주석 (//)

한 줄에 대한 주석을 작성할 때 사용합니다.

int score = 90; // 학생의 점수를 저장하는 변수

💡 단축키 팁
대부분의 IDE(예: IntelliJ, Eclipse, VS Code)에서는 Ctrl + / 단축키를 사용하여 해당 줄을 주석 처리하거나 해제할 수 있습니다.
Mac 사용자의 경우 Command + / 를 사용하세요.

 

📌 블록 단위 주석 (/* */)

여러 줄에 걸쳐 주석을 작성할 때 사용합니다.

/*
이 코드는 학생의 점수를 기준으로
합격 여부를 판단합니다.
*/
if (score >= 60) {
    System.out.println("합격");
}

2. 문서화 주석 (Documentation Comment)

/** */ 형태의 주석으로, Javadoc 툴을 사용해 API 문서를 자동 생성할 때 사용됩니다.
클래스, 메서드, 필드, 인터페이스 등 선언부 바로 위에 작성합니다.

/**
 * Calculator 클래스는 기본적인 계산 기능을 제공합니다.
 * @author 홍길동
 * @version 1.0
 */
public class Calculator {

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

 

---

🔖 요약

주석 종류	형태	용도
행 단위 주석	//	한 줄 설명
블록 단위 주석	/* ... */	여러 줄 설명
문서화 주석	/** ... */	Javadoc 문서 자동 생성에 사용