Java 코드에 주석을 추가하는 방법 총정리

Java에서 주석(Comment)은 컴파일러와 인터프리터가 실행하지 않는 문장입니다. 주석은 변수, 메서드, 클래스 또는 특정 문장에 대한 설명 정보를 제공하는 데 사용되며, 필요에 따라 일시적으로 프로그램 코드를 숨기는 용도로도 활용할 수 있습니다.

Java 주석의 종류

Java에는 세 가지 유형의 주석이 있습니다.

• 한 줄 주석(Single line comment)
• 여러 줄 주석(Multi-line comment)
• 문서화 주석(Documentation comment)

1. 한 줄 주석(Single Line Comment)

한 줄 주석은 //로 시작하며 해당 줄의 끝까지 유효합니다. 간단한 설명이나 임시 메모를 남길 때 가장 많이 사용됩니다.

예제 1

public class SingleLineComment {
    public static void main(String[] args) {
        // 콘솔에 출력하기 위한 코드
        System.out.println("Welcome to Tutorials Point");
    }
}

출력 결과

Welcome to Tutorials Point

2. 여러 줄 주석(Multi-Line Comment)

여러 줄 주석은 /*로 시작하여 */로 끝나며, 그 사이의 여러 줄에 걸쳐 내용을 작성할 수 있습니다. 긴 설명이나 여러 줄에 걸친 코드 블록을 일시적으로 비활성화할 때 유용합니다.

예제 2

public class MultiLineComment {
    public static void main(String[] args) {
        /* 콘솔에 "Welcome to Tutorials Point"를
           출력하는 코드입니다.
        */
        System.out.println("Welcome to Tutorials Point");
    }
}

출력 결과

Welcome to Tutorials Point

3. 문서화 주석(Documentation Comment)

문서화 주석은 /**로 시작하여 */로 끝나며 여러 줄에 걸쳐 작성됩니다. 이 주석은 반드시 클래스, 인터페이스, 메서드 또는 필드 정의 바로 앞에 위치해야 하며, javadoc 도구를 통해 HTML 형식의 API 문서를 자동으로 생성하는 데 사용됩니다.

예제 3

/**
    이것은 문서화 주석입니다.
    이 클래스는 Java에서 문서화 주석의 사용법을 보여주기 위해 작성되었습니다.
    이 프로그램은 콘솔에 "Welcome to Tutorials Point"라는 텍스트를 출력합니다.
*/
public class DocumentationComment {
    public static void main(String args[]) {
        System.out.println("Welcome to Tutorials Point");
    }
}

출력 결과

Welcome to Tutorials Point

마무리

주석은 코드의 가독성과 유지보수성을 높이는 중요한 요소입니다. 짧은 설명에는 한 줄 주석(//), 긴 설명에는 여러 줄 주석(/* */), API 문서 생성이 필요한 경우에는 문서화 주석(/** */)을 적절히 활용하면 됩니다.