Java 주석: 종류, 사용법, 모범 사례

Java 주석

이 가이드는 Java 주석이 무엇인지, 왜 중요한지, 더 명확하고 유지보수하기 쉬운 코드를 위해 올바르게 사용하는 방법을 설명합니다.

프로그래밍에서 주석은 Java 컴파일러가 무시하는 소스 코드 섹션입니다. 실행에 영향을 주지 않으면서 개발자가 코드 의도를 이해하도록 돕습니다. 예:

// 두 변수 선언 및 초기화
int a = 1;
int b = 3;
// 출력 출력
System.out.println("This is output");

여기서 두 개의 주석을 사용했습니다: 두 변수 선언 및 초기화와 출력 출력.

Java의 주석 유형

Java는 두 가지 주요 주석 스타일을 지원합니다:

• 단일 줄 주석
• 여러 줄 주석

단일 줄 주석

단일 줄 주석은 //로 시작하여 줄 끝까지 확장됩니다. 예:

// "Hello, World!" 프로그램 예제
class Main {
    public static void main(String[] args) {
        // "Hello, World!" 출력
        System.out.println("Hello, World!");
    }
}

출력:

Hello, World!

두 개의 단일 줄 주석을 사용했습니다: "Hello, World!" 프로그램 예제와 "Hello, World!" 출력. 컴파일러는 //부터 줄 끝까지 모든 것을 무시합니다.

여러 줄 주석

여러 줄이 필요하면 /* … */를 사용합니다. 예:

/* 이것은 여러 줄 주석의 예입니다.
 * 프로그램은 "Hello, World!"를 표준 출력으로 출력합니다.
 */
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

출력:

Hello, World!

컴파일러는 /*와 */ 사이의 모든 것을 건너뜁니다. 이는 전통적인 주석이라고도 합니다.

주석 효과적으로 사용하기

주석은 명확한 코드를 대체해서는 안 됩니다. 먼저 잘 구조화된 자기 설명적인 코드를 작성한 다음, 복잡한 알고리즘, 설계 선택, 명백하지 않은 로직 등 결정의 "이유"를 설명하기 위해 주석을 추가하세요.

일부는 최소한의 주석을 옹호하지만, 간결한 설명은 향후 유지보수자의 가독성을 크게 향상시킬 수 있습니다.

참고: 코드가 어떻게 작동하는지보다 왜 존재하는지 설명하는 주석을 선호하세요.