Java 주석문(Comment)

주석(comment)은 로직에 대한 설명이나 코드를 비활성화 할 때 사용한다. 주석은 코드에 영향을 미치지 않으며 컴파일(프로그램 해석)의 대상에서 제외된다.

자바에서 사용할 수 있는 주석문은 3가지 종류가 있다.

단일 라인 주석 (Single-line comment)

//을 시작하는 그 라인의 끝까지 주석 처리 된다.

public static void main(String[] args) {
    // 정수 변수를 선언 할때는 아래와 같이 코드를 작성한다.
    int num1;
}

블럭 주석 (Multi-line Comment)

/*에서 */까지의 모든 내용이 주석 처리 된다.

public static void main(String[] args) {
    int num1 = 100;
    int num2 = 200;
   
    /* 아래 코드는 선언한 정수의 합을 계산해서 표시해 준다.
       num1은 100이고, num3는 200이어서 결과는 300이 나온다. */
    System.out.println(num1 + num2);
}

특성상 여러 라인을 주석을 중첩 할 수 없으므로 주의해애 한다. 이 때문에 일반적으로는 우선은 //를 우선해 이용하는 것을 추천한다.

문서 주석 (Document comment)

/**에서 */까지의 모든 내용이 주석처리 된다. 프로그램을 문서화 javadoc에 위해 생성되는 HTML 파일에서 사용된다. 주석 내용에 HTML 태그 사용 가능하다.

/**
 * main 메소드는 자바 응용 프로그램의 실행 시작점입니다.
 */
public static void main(String[] args) {
    String str = null;
}