자바의 주석(comment)

자바에서 주석은 코드에 대한 설명이나 메모를 추가하는 데 사용되며, 실제 프로그램 실행에는 영향을 주지 않습니다. 주석을 사용하면 코드의 가독성을 높이고, 다른 개발자들에게 코드의 기능이나 특정 부분에 대한 정보를 전달하는 데 도움이 됩니다. 자바에서는 세 가지 유형의 주석을 사용할 수 있습니다.

 

1. 한 줄 주석 (Single-line comments)

// 기호로 시작하며, 해당 줄의 끝까지 주석으로 간주됩니다.

// 이것은 한 줄 주석입니다.
int x = 5;

 

2. 여러 줄 주석 (Multi-line comments)

/*로 시작하고 */로 끝나는 사이의 모든 내용이 주석으로 간주됩니다.

/*
이것은 여러 줄에 걸쳐진
주석입니다.
*/
int y = 10;

 

3. 문서 주석 (Javadoc comments)

/**로 시작하고 */로 끝납니다. 이 주석 유형은 특별히 Java API 문서를 생성하기 위해 설계되었습니다.

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

 

javadoc 도구를 사용하면 이러한 문서 주석에서 API 문서를 자동으로 생성할 수 있습니다.

주석은 코드를 이해하고 유지 보수하는 데 도움을 주는 중요한 도구이지만, 과도하게 주석을 사용하거나 불필요한 주석을 남기는 것은 피해야 합니다. 가장 좋은 주석은 코드의 목적과 기능을 명확하게 설명하는 주석입니다.

 

With ChatGPT