[JAVA] 주석의 모든 것

1 주석의 종류

1-1 한 줄 주석(Line Comment)

Java에서 // 기호를 사용해 한 줄에 짧게 설명을 붙일 수 있는 주석입니다.

이 주석은 // 뒤에 오는 모든 내용을 컴파일러가 무시하며 간단한 설명이나 메모를 남길 때 유용합니다. 주로 변수나 조건문의 의미를 덧붙이거나 코드의 의도를 간단히 설명할 때 사용됩니다.

 

 

 

JAVA

// 이 변수는 사과의 개수를 저장합니다.
int appleCount = 10;

// 사과가 5개 이상이면 구매할 수 있습니다.
if (appleCount >= 5) {
    System.out.println("사과를 살 수 있습니다."); // 사과 구매 가능 메시지 출력
}

💡 Tip

다음 단축키를 사용하면 문서 주석을 자동으로 생성할 수 있습니다.

• 직접 입력 ( // 입력 )

• 단축키 사용 ( Ctrl + / )

1-2여러 줄 주석(Block Comment)

Java에서는 /* */ 기호를 사용하여 여러 줄에 걸쳐 설명을 남길 수 있는 주석입니다.

이 주석 방식은 한 줄이 아닌 복수의 줄을 사용해 설명이 필요할 때 주로 사용되며 코드의 일부를 임시로 비활성화하거나 함수나 클래스 위에 설명을 달 때 유용합니다.

/*로 시작해서 */로 끝나는 범위 안의 모든 내용은 컴파일러가 무시합니다.

 

 

 

JAVA

/*
 * 사과가 충분히 있는 경우에만 구매 가능하다는 메시지를 출력합니다.
 * (여기서는 5개 이상을 '충분한 수량'으로 가정합니다)
 */
int appleCount = 10;

if (appleCount >= 5) {
    System.out.println("사과를 살 수 있습니다.");
}

💡 Tip

다음 단축키를 사용하면 문서 주석을 자동으로 생성할 수 있습니다.

• 직접 입력 ( /* 입력 후 Enter )

• 단축키 사용
• 시작 : Ctrl + Shift + /

• 해제 : Ctrl + Shift + \

1-3 문서 주석(Documentation Comment)

Java에서 /** */ 기호를 사용해 클래스나 메서드에 대한 설명을 문서 형태로 남길 수 있는 주석입니다.

이 주석은 단순한 설명을 넘어서 Java의 javadoc 도구를 통해 API 문서로 자동 변환할 수 있는 특징이 있습니다. 주로 클래스, 메서드, 필드, 생성자 등에 사용되며 코드의 역할, 입력값, 반환값 등을 구조적으로 문서화할 수 있습니다.

 

 

 

JAVA

/**
 * 주어진 사과 개수가 구매 기준을 충족하는지 확인합니다.
 *
 * @param appleCount 사과의 개수
 * @return 구매 가능 여부 (5개 이상이면 true)
 */
public static boolean canBuy(int appleCount) {
    return appleCount >= 5;
}

💡 Tip

다음 단축키를 사용하면 문서 주석을 자동으로 생성할 수 있습니다.

• 직접 입력 ( /** 입력 후 Enter )

• 단축키 사용 ( Alt + Shift + J )

2 주석 키워드

주석 키워드는 주석 내에 특별한 목적이나 상태를 표시하기 위해 사용하는 단어입니다.

주로 // 또는 /* */ 주석 안에 작성하며 해야 할 작업(TODO)이나 수정이 필요한 부분(FIXME) 등을 표시하면 개발 도구가 이를 자동으로 인식해 작업(Task) 목록에 정리해줍니다. 이를 통해 코드 속 메모를 보다 체계적으로 관리할 수 있습니다.

또한 설정을 통해 사용자 지정 키워드를 추가하는 것도 가능합니다. 이를 활용하면 팀 내에서 자주 사용하는 주석 태그(REVIEW, LATER 등)를 정의하여 자신만의 작업 관리 체계를 만들 수 있습니다.

2-1 TODO

TODO는 해야 할 일을 나타내는 주석 키워드입니다.

개발 중 아직 구현하지 않았거나 나중에 추가해야 할 작업이 있는 부분에 표시하는 데 사용됩니다.

 

 

 

JAVA

// TODO: 나이도 함께 출력하도록 수정하기
System.out.println("이름: 홍길동");

2-2 FIXME

FIXME는 수정이 필요한 부분을 나타내는 주석 키워드입니다.

개발 중 발견한 문제점이나 버그 또는 임시로 처리한 코드에 대해 나중에 반드시 수정해야 할 부분임을 표시할 때 사용합니다.

 

 

 

JAVA

// FIXME: 실제 인증 토큰으로 교체해야 함
String token = "test-token";

2-3

주석 키워드 관리 및 확인 방법

코드에 작성한 TODO나 FIXME 같은 주석 키워드를 한눈에 확인할 수 있는 Tasks 뷰를 여는 방법과 직접 원하는 키워드를 추가해 관리하는 방법을 소개합니다.

2-3-1Eclipse

• Tasks 뷰 열기

• Task Tags 설정