[Java] 자바 주석처리 (한 줄, 여러 줄, 문서화)

주석은 코드를 이해하고 유지 보수하는 데 중요한 도구입니다.

주석은 코드의 의도와 작동 방식을 설명하고, 다른 개발자들과의 소통하는데 필수적입니다.

오늘의 자바에서 사용하는 주석에 대해 알아보겠습니다.

---

 

💻 주석의 역할

• 자신 또는 다른 사람을 위한 코드의 의도나 동작 방식을 설명하는 데 사용됩니다.
• 코드의 특정 부분에 대한 설명, 작업의 목적, 변경 이력 등을 주석으로 기록할 수 있습니다. 
• 코드를 이해하고 유지보수하는 데 도움이 됩니다.

---

📌한 줄 주석

• 한 줄 주석은 코드 한 줄을 설명하는 데 주로 사용됩니다. 
• ' // ' 기호를 사용하여 표시합니다.

int result = a + b; // 변수 a와 b를 더한 값을 저장합니다.

---

📌여러 줄 주석

• 코드 블록을 설명하는데 유용한 주석처리 입니다.
• ' /* ' 로 시작하고 ' */ ' 로 끝냅니다.

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

---

📌문서화 주석(Javadoc 주석)

• 문서화 주석은 코드의 API문서를 생성하는 데 사용됩니다.
• 클래스, 메서드, 필드 등을 설명하고 메서드의 매개변수, 반환값, 예외 등을 문서화 합니다.
• ' /** ' 로 시작하고 ' */ ' 로 끝냅니다.

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

---

📌자바 주석 사용시 주의사항

• 코드의 의도나 동작 방식을 명확하게 작성
• 코드를 변경할때 주석도 업데이트하여 일관성 유지
• 너무 많은 양의 주석은 코드의 가독성을 떨어뜨림