JAVA Comments

자바에서 주석은 코드에 대한 설명을 추가하거나 특정 코드를 일시적으로 비활성화할 때 사용해요. 

컴파일러는 주석을 무시하기 때문에 프로그램 실행에 영향을 주지 않아요. 

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

---

---

한 줄 주석 (Single-line Comments)

가장 일반적으로 사용되는 주석이에요. 

**두 개의 슬래시(//)**를 사용하여 한 줄을 주석 처리해요. 

주로 코드의 특정 라인이나 변수에 대한 간단한 설명을 덧붙일 때 유용해요.

public class CommentsExample {
    public static void main(String[] args) {
        // 아래 코드는 'Hello, World!'를 출력합니다.
        System.out.println("Hello, World!");

        int x = 10; // 변수 x를 선언하고 10으로 초기화합니다.
    }
}

Java

---

---

여러 줄 주석 (Multi-line Comments)

여러 줄에 걸쳐 긴 설명을 작성할 때 사용해요.

**슬래시와 별표(/*)**로 시작하고 **별표와 슬래시(*/)**로 끝나요.

주로 코드 블록 전체에 대한 설명이나 특정 기능을 비활성화할 때 사용돼요.

/*
이 프로그램은 CommentsExample 클래스를 사용하여
자바 주석의 다양한 사용법을 보여줍니다.
*/
public class CommentsExample {
    public static void main(String[] args) {
        /*
        // 이 코드는 주석 처리되어 실행되지 않습니다.
        System.out.println("This code will not run.");
        */
        System.out.println("Hello, World!");
    }
}

Java

---

---

Javadoc 주석 (Documentation Comments)

**슬래시와 두 개의 별표(/**)**로 시작하고 **별표와 슬래시(*/)**로 끝나요. 

이 주석은 Javadoc 도구를 사용하여 API 문서(Documentation)를 자동으로 생성하는 데 사용돼요. 

주로 클래스, 메서드, 필드 등에 대한 자세한 설명과 파라미터, 반환 값 등에 대한 정보를 포함해요.

/**
 * 이 클래스는 Javadoc 주석 예제를 보여줍니다.
 * @author 홍길동
 * @version 1.0
 */
public class JavadocExample {

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

Java

---