자바 주석 (Comment)이란?

💡 자바 주석 (Comment)이란?

주석은 코드에 대한 설명이나 메모를 남기는 기능입니다.

가장 중요한 특징은 주석으로 처리된 부분은 컴파일러가 무시하기 때문에 프로그램 실행에 전혀 영향을 주지 않는다는 점이에요.

주석을 사용하는 이유

• 코드 이해를 돕기 위해 (내가 쓴 코드도 시간이 지나면 헷갈릴 수 있어요!)
• 다른 개발자와의 협업 시 코드의 의도를 명확하게 전달하기 위해
• 특정 코드를 일시적으로 비활성화할 때

---

📚 자바 주석의 종류와 예제

자바에는 크게 세 가지 종류의 주석이 있어요.

종류	기호	용도
한 줄 주석 (Single-line)	//	한 줄만 주석 처리할 때
여러 줄 주석 (Multi-line)	/* ... */	여러 줄의 내용을 한 번에 주석 처리할 때
문서 주석 (Javadoc)	/** ... */	공식 문서(API 문서)를 만들 때 사용 (가장 전문적인 용도)

---

1. 한 줄 주석: //

// 뒤에 오는 그 줄의 끝까지만 주석으로 처리됩니다. 가장 흔하게 사용돼요.

Java

 

public class CommentExample {
    public static void main(String[] args) {
        // 이 줄은 주석입니다. 컴파일되지 않아요.
        int number = 10; // 변수 number에 10을 할당합니다.

        System.out.println(number); // number 값을 화면에 출력
    } // main 메서드의 끝
}

2. 여러 줄 주석: /* ... */

/*로 시작해서 */로 끝나는 모든 내용을 주석으로 처리합니다. 긴 설명을 적거나, 코드 블록 전체를 비활성화할 때 유용해요.

Java

 

public class MultiLineCommentExample {
    public static void main(String[] args) {
        /*
        이것은 여러 줄 주석의 시작입니다.
        아래 코드는 사용자에게 환영 메시지를 보여주는 역할을 합니다.
        */
        System.out.println("Hello, Java World!");

        /*
        // 여러 줄 주석 안에서는 한 줄 주석 기호도
        int a = 5;
        int b = 3;
        // 모두 주석으로 처리됩니다.
        */
    }
}

3. 문서 주석: /** ... */

/**로 시작해서 */로 끝납니다. 클래스, 메서드 등에 대한 공식적인 설명을 작성할 때 사용하며, Javadoc이라는 도구를 이용해 API 문서를 자동으로 만들 수 있어요.

Java

 

/**
 * 이 클래스는 간단한 덧셈 기능을 제공하는 예제입니다. (클래스 설명)
 * @author 홍길동 (작성자 정보)
 * @version 1.0 (버전 정보)
 */
public class JavadocExample {

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

    public static void main(String[] args) {
        JavadocExample example = new JavadocExample();
        int sum = example.add(5, 7);
        System.out.println("합계: " + sum);
    }
}

---

📌 주석 사용 팁

• 설명할 필요 없는 코드에는 주석을 달지 마세요. (예: int x = 10; // x에 10을 넣는다. 같은 주석은 불필요해요.)
• "왜(Why)" 이 코드가 필요한지에 초점을 맞춰 주석을 작성하는 것이 좋습니다.
• 코드를 수정하면 주석도 함께 수정해서 내용이 일치하도록 유지해야 합니다.