Java 블록 주석

Aryan Tyagi 2023년10월12일
Java 블록 주석

Java에서는 주석을 사용하여 코드에 대한 추가 설명과 정보를 제공함으로써 Java 코드의 가독성을 향상시켜 코드를 유지 관리하고 버그 및 오류를 쉽게 찾을 수 있도록 합니다. 자바 코드를 컴파일하는 동안 컴파일러는 주석 내의 텍스트와 명령문을 완전히 제외합니다.

이 자습서에서는 Java의 블록 주석에 대해 설명합니다.

블록 주석은 동시에 여러 줄의 코드에 주석을 달 때 사용됩니다. /**/를 사용하여 블록 주석을 삽입합니다. 블록 주석은 여러 줄로 확장되거나 코드 문 내에 삽입될 수 있습니다. 주석 구분 기호 사이에 표시되는 텍스트만 주석으로 간주되며 컴파일 중에 무시됩니다.

예를 들어,

public class multilinecomment {
  public static void main(String[] args) {
    /* we have declared an integer n having value 007
    and a floating point variable z
    storing value of pi. */
    int n = 007;
    double z = 3.14;
    System.out.println(n);
    System.out.println(z);
  }
}

출력:

7
3.14

Java에서 사용할 수 있는 또 다른 유형의 여러 줄 주석이 있습니다. 이를 위해 /***/를 사용하여 문서 주석을 묶습니다. 이것은 javadoc 도구에 의해 생성된 프로그램에 대한 공식 문서 API를 정의하는 데 사용됩니다. javadoc은 소스 파일 모음에서 선언 및 문서 주석을 구문 분석하고 클래스, 인터페이스, 생성자, 메서드 및 필드를 설명하는 HTML 페이지 모음을 생성하는 도구입니다.

예를 들어,

public class javadoccomment {
  /**  multi() method returns multiplication of numbers.*/
  public static int multi(int a, int b) {
    return a * b;
  }

  /**  addition() method returns addition of numbers.*/
  public static int addition(int a, int b) {
    return a + b;
  }

  /**  subtract() method returns subtraction of numbers.*/
  public static int subtract(int a, int b) {
    return a - b;
  }
  public static void main(String[] args) {}
}

위의 코드를 javac 도구로 컴파일하면 javadoccomment.java가 생성되고 javadoccomment 클래스에 대한 HTML 파일이 생성됩니다. 주어진 HTML 파일을 열고 javadoccomment 클래스에 대한 문서 주석을 보십시오.