[Java]자바 주석: 코드 이해와 유지 보수를 위한 필수 기능

코드를 작성하면서 주석을 작성하는 것은 여러분의 코드를 다른 사람들과 공유하고 유지보수할 때 굉장히 중요합니다. 이번 포스팅에서는 자바의 주석에 대해 알아보겠습니다. 자바 코드에는 어떤 종류의 주석이 있는지, 어떤 목적으로 사용되는지, 그리고 어떻게 작성해야 하는지에 대해 자세히 알아봅시다.

≣ 목차

• 주석이란?🧐
• 주석의 종류🌈
• 핵심 내용👀

---

1. 주석이란?🧐

자바에서의 주석은 프로그래밍 코드 내에서 설명이나 메모를 작성할 때 사용되는 문장입니다.

주석은 컴파일러에 의해 무시되며, 프로그램의 실행에 직접적인 영향을 미치지 않습니다.

주석은 코드를 이해하기 쉽게 하거나, 코드의 일부를 임시로 비활성화할 때 사용됩니다.

이를 통해 코드의 가독성을 높이고, 코드를 유지보수하기 쉽게 만들어 줍니다.

주석은 다른 개발자들과의 협업이나 나중에 코드를 다시 검토할 때도 유용합니다.

주석을 사용할 때 한 가지 주의사항이 있습니다.

코드에서 문자열 내에 주석을 포함하는 경우, 그 주석은 문자열 데이터로 해석된다는 점입니다.

아래 코드에서는 문자열 "이 문자열은 주석을 포함하고 있습니다. // 주석입니다. " 안에 주석이 포함되어 있지만, 이는 그냥 문자열로 처리됩니다. 따라서 출력 결과는 주석이 포함된 문자열 그대로 출력됩니다.

public class CommentInsideString {
    public static void main(String[] args) {
        // 아래 문자열 안에는 주석이 포함되어 있지만, 이는 그냥 문자열로 인식됩니다.
        String message = "이 문자열은 주석을 포함하고 있습니다. // 주석입니다. ";

        // 위 문자열을 출력하면 주석은 그대로 문자열로 처리됩니다.
        System.out.println(message);
    }
}

---

2. 주석의 종류🌈

자바에서는 다음과 같은 주석 형식이 주로 사용됩니다.

행 주석

//로 시작하며 해당 줄의 끝까지 주석으로 처리됩니다.

이클립스 단축키

추가 ▶ Ctrl + /

해제 ▶Ctrl+/

// 이 줄은 주석 처리되어 코드 실행 시 무시됩니다.
int x = 10; // 변수 x에 10을 할당합니다.

범위 주석

/*로 시작하고*/로 끝나며 그 사이에 있는 모든 내용이 주석으로 처리됩니다.

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

이클립스 단축키

추가 ▶Ctrl+ Shift + /

해제 ▶Ctrl+ Shift + \

/*
 * 이 영역은 범위 주석으로 처리됩니다.
 * 주로 코드 블록에 대한 설명이나 문서화에 사용됩니다.
 */
int y = 20; // 범위 주석 내에 있는 코드는 주석 처리됩니다.

도큐먼트 주석

/**로 시작하고*/로 끝나며 주로 클래스, 메서드, 변수 등에 대한 문서화를 위해 사용됩니다.

JavaDoc 형식의 주석으로, 자동 문서 생성 도구에서 활용됩니다.

이클립스 단축키

추가 ▶ Alt+Shift+ J

해제 ▶ Shift+J

/**
 * 이 클래스는 간단한 예제 클래스입니다.
 * 주석을 통해 클래스의 역할과 사용 방법을 설명합니다.
 */
public class Example {
    /**
     * 이 메서드는 두 정수를 더하는 기능을 수행합니다.
     * @param a 첫 번째 정수
     * @param b 두 번째 정수
     * @return 두 정수의 합
     */
    public int add(int a, int b) {
        return a + b;
    }
}

---

3. 핵심 내용👀