자바 주석 사용법 총 정리! 개발자가 꼭 알아야 할 핵심 팁

자바 수석 사용법

 

프로그래밍을 하다 보면 코드가 길어지고 복잡해지면서 "이 코드는 도대체 무슨 역할을 하는 거지?"라는 생각이 들 때가 있습니다.
이럴 때 주석(Comment)을 사용하면 코드의 의미를 쉽게 파악할 수 있습니다. 주석은 프로그램 실행에는 영향을 미치지 않지만, 코드를 설명하거나 특정 부분을 비활성화할 때 유용하게 사용됩니다. 특히 팀 프로젝트를 하거나, 오랜 시간이 지나 다시 코드를 볼 때 큰 도움이 되죠! 

오늘은 자바에서 사용할 수 있는 주석의 종류와 올바른 활용법을 초보자도 쉽게 이해할 수 있도록 설명해 드리겠습니다. 😊

 

📌 목차

1. 한 줄 주석 (`//`)
2. 여러 줄 주석 (`/* */`)
3. 문서 주석 (`/** */`)
4. 주석 활용 팁
5. 마무리

 

1. 한 줄 주석 (`//`)

한 줄짜리 주석을 작성할 때 사용합니다.
// 이후의 내용은 실행되지 않고, 코드에 대한 설명을 적을 수 있습니다.

public class Main {
    public static void main(String[] args) {
        // 두 숫자를 더하는 코드
        int num1 = 10;
        int num2 = 20;
        int sum = num1 + num2; // 결과 저장
        System.out.println(sum); // 결과 출력 (30)
    }
}

💡 // 이후에 적힌 내용은 실행되지 않으며, 코드의 의미를 설명하는 역할을 합니다.

 

2. 여러 줄 주석 (`/* */`)

여러 줄에 걸쳐 긴 설명을 작성할 때 사용합니다.
/*로 시작해서 */로 끝나는 부분은 모두 주석으로 처리됩니다.

public class Main {
    public static void main(String[] args) {
        /*
        이 코드는 두 개의 숫자를 더한 후
        그 결과를 출력하는 프로그램입니다.
        */
        int a = 15;
        int b = 25;
        int result = a + b;
        System.out.println("결과: " + result); // 40 출력
    }
}

💡 여러 줄의 설명이 필요할 때는 /* */를 사용하면 됩니다.

 

3. 문서 주석 (`/** */`)

문서 주석은 주로 클래스, 메서드, 변수 등의 설명을 작성할 때 사용됩니다.
특히 Javadoc이라는 도구를 사용하면 문서화된 HTML을 자동으로 생성할 수 있습니다.

/**
 * 이 클래스는 간단한 계산기 기능을 제공합니다.
 */
public class Calculator {
    /**
     * 두 개의 숫자를 더하는 메서드입니다.
     * @param num1 첫 번째 숫자
     * @param num2 두 번째 숫자
     * @return 두 숫자의 합
     */
    public int add(int num1, int num2) {
        return num1 + num2;
    }
}

💡 @param, @return 같은 태그를 사용하면 함수의 입력값과 출력값을 쉽게 설명할 수 있습니다.
📌 이 주석은 Javadoc을 이용해 HTML 문서로 변환할 수도 있습니다!

 

4. 주석 활용 팁

주석을 잘 활용하면 코드의 가독성을 높이고, 협업할 때 큰 도움이 됩니다.

 

✅ 1) 중요한 부분에 주석을 추가하세요.

public class Main {
    public static void main(String[] args) {
        int x = 10;
        int y = 20;

        // x와 y의 값을 서로 교환하는 코드
        int temp = x;
        x = y;
        y = temp;

        System.out.println("x: " + x + ", y: " + y); // x: 20, y: 10
    }
}

💡 값 교환 로직처럼 한눈에 이해하기 어려운 부분에는 주석을 추가하세요!

 

✅ 2) TODO 주석을 사용하여 해야 할 일을 기록하세요.

public class Main {
    public static void main(String[] args) {
        // TODO: 예외 처리 추가 필요
        System.out.println("Hello, World!");
    }
}

💡 TODO를 사용하면 나중에 수정해야 할 부분을 쉽게 찾을 수 있습니다.

 

✅ 3) FIXME 주석을 사용하여 수정해야 할 버그를 표시하세요.

public class Main {
    public static void main(String[] args) {
        // FIXME: 배열 범위를 벗어나는 오류 발생 가능성 있음
        int[] numbers = {1, 2, 3};
        System.out.println(numbers[3]); // 오류 발생
    }
}

💡 FIXME를 사용하면 수정이 필요한 부분을 강조할 수 있습니다.

 

5. 마무리 🚀

자바 주석을 활용하면 코드가 더 이해하기 쉬워지고 유지보수도 편리해집니다.

• 한 줄 주석 (`//`): 짧은 설명을 추가할 때 사용
• 여러 줄 주석 (`/* */`): 긴 설명을 작성할 때 사용
• 문서 주석 (`/** */`): 함수나 클래스 정보를 문서화할 때 사용

주석을 적절히 활용하면 코드가 더 이해하기 쉬워지고, 유지보수도 편리해집니다.

좋은 코드란 누구나 쉽게 읽을 수 있는 코드라는 점을 기억하고, 주석을 적절히 활용하세요! 😊

 

추  천  글

 

자바 변수 완벽 가이드

 

 

자바(Java) 기본 문법 자료형, 참조 자료형: 한눈에 정리

 

 

인텔리제이(IntelliJ) 설치 가이드: 빠르고 간편하게 따라하기!