주석(Comments)

코드에 대한 설명을 추가하여 다른 개발자들, 또는 나중에 자신이 코드를 다시 봤을 때 이해하기 쉽도록 도와주는 도구이다.

• 주석은 컴파일 과정에서 실행되지 않고 무시되므로 프로그램에 직접적인 영향을 주지 않는다.

한 줄 주석

Single-line Comments;
코드의 특정 부분을 설명하기 위해 사용한다.

• //로 시작하며, 이 뒤에 오는 텍스트는 주석으로 처리된다.

// 이것은 한 줄 주석입니다.
int number = 5; // 이 변수는 숫자를 저장합니다.

TODO 주석

• 추후 해야 할 일을 나타내기 위해 사용된다.
• 주로 미완성 부분이나 나중에 추가하거나 수정해야 할 기능을 표시할 때 사용된다.

// TODO: 이 메소드의 로직을 완성해야 합니다.

FIXME 주석

• 수정해야 할 코드의 부분을 나타내며, 버그 수정이나 코드 개선이 필요한 곳에 사용된다.

// FIXME: 이 부분에서 발생하는 오류를 수정해야 합니다.

여러 줄 주석

Multi-line Comments;
코드의 여러 줄에 걸친 설명을 추가할 때 사용한다

• 여러 줄 주석을 적용하고자 하는 부분을 /*로 시작하여 */로 끝낸다.

/*
이것은 여러 줄 주석입니다.
여러 줄에 걸쳐 설명을 추가할 수 있습니다.
*/
int number = 5;

문서 주석

Documentation Comments;
JavaDoc 도구를 사용하여 API 문서를 생성할 때 사용한다.

• 문서 주석은 클래스, 메서드, 변수 등에 대한 문서화에 사용한다.

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

• 문서 주석은 또한 Eclipse나 IntelliJ와 같은 IDE 프로그램을 사용할 때,
  해당 클래스로 이동하지 않고도 주석에 작성된 설명을 볼 수 있는 기능을 제공해준다.