Java Comments
Java Comments: 자바 주석 가이드
- *주석(Comment)**은 Java 프로그램에서 코드의 설명이나 참고용 메모를 작성하는 데 사용되며, 프로그램 실행에는 영향을 미치지 않습니다. 주석은 코드를 이해하기 쉽게 하거나, 일시적으로 코드를 비활성화할 때 유용합니다. Java에서는 세 가지 종류의 주석을 사용할 수 있습니다: 단일 행 주석, 여러 행 주석, 그리고 문서화 주석.
이 가이드는 Java에서 주석을 사용하는 방법과 그 목적을 설명합니다.
1. 단일 행 주석 (Single-Line Comment)
단일 행 주석은 한 줄의 주석을 작성할 때 사용됩니다. **//**를 사용해 주석을 시작하고, 그 뒤의 내용은 해당 줄 끝까지
주석으로 처리됩니다.
사용 예:
public class SingleLineComment {
public static void main(String[] args) {
// 이 코드는 Hello, World!를 출력합니다.
System.out.println("Hello, World!"); // 출력: Hello, World!
}
}
설명:
//뒤에 작성된 내용은 해당 줄에서만 주석 처리됩니다.- 단일 행 주석은 간단한 설명이나 코드에 대한 짧은 메모를 작성할 때 유용합니다.
2. 여러 행 주석 (Multi-Line Comment)
여러 행 주석은 주석이 여러 줄에 걸쳐 작성될 때 사용됩니다. **/* ... */**로 주석을 시작하고 종료하며, 그 사이의
모든 내용이 주석으로 처리됩니다.
사용 예:
public class MultiLineComment {
public static void main(String[] args) {
/*
이 코드는 여러 줄 주석 예시입니다.
Hello, World!를 출력합니다.
*/
System.out.println("Hello, World!");
}
}
설명:
- *
/**로 주석을 시작하고, **/*로 주석을 종료합니다. - 여러 줄의 설명을 작성할 때 유용하며, 주로 코드 블록이나 함수 설명을 추가할 때 사용됩니다.
3. 문서화 주석 (Documentation Comment)
문서화 주석은 주로 API 문서나 코드 설명서를 생성하는 데 사용됩니다. /** ... */ 형식으로 작성하며,
Javadoc 도구를 통해 자동으로 HTML 문서를 생성할 수 있습니다. 이는 코드의 사용법, 클래스, 메소드, 필드 등에 대한 설명을 작성하는 데 유용합니다.
사용 예:
/**
* 이 클래스는 Hello, World!를 출력하는 클래스입니다.
*
* @author John Doe
* @version 1.0
*/
public class DocumentationComment {
/**
* 이 메소드는 프로그램의 진입점입니다.
* Hello, World!를 출력합니다.
*
* @param args 명령줄 인수
*/
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
설명:
- *
/***로 시작하고 **/*로 종료하는 문서화 주석은 Javadoc 도구를 사용하여 HTML 문서를 생성할 때 유용합니다. - 주로 클래스, 메소드, 필드의 설명을 위해 사용됩니다.
- 태그를 사용해 추가적인 정보를 제공할 수 있습니다:
@author: 작성자 정보@version: 버전 정보@param: 메소드 매개변수 설명@return: 메소드 반환값 설명
4. 주석 사용 예시
4.1. 단일 행 주석 사용 예
public class CommentExample {
public static void main(String[] args) {
// 변수 선언
int number = 10;
// number 값을 출력
System.out.println("Number: " + number);
}
}
4.2. 여러 행 주석 사용 예
public class CommentExample {
public static void main(String[] args) {
/*
이 코드는 여러 줄 주석의 예입니다.
변수 선언 후, 해당 변수의 값을 출력합니다.
*/
int number = 10;
System.out.println("Number: " + number);
}
}
4.3. 문서화 주석 사용 예
/**
* 이 클래스는 간단한 수학 연산을 수행하는 클래스입니다.
*/
public class MathOperations {
/**
* 두 수의 합을 반환합니다.
*
* @param a 첫 번째 정수
* @param b 두 번째 정수
* @return 두 수의 합
*/
public int add(int a, int b) {
return a + b;
}
public static void main(String[] args) {
MathOperations math = new MathOperations();
System.out.println("5 + 3 = " + math.add(5, 3));
}
}
5. 주석 활용 팁
- 코드 설명: 주석은 코드의 목적과 동작을 설명하는 데 사용됩니다. 복잡한 로직이나 특별한 동작이 있는 경우 주석을 통해 이를 명확하게 전달할 수 있습니다.
- 비활성화: 주석을 사용하여 특정 코드 블록을 임시로 비활성화할 수 있습니다.
- 문서화: Javadoc 주석을 사용해 코드를 자동으로 문서화할 수 있으며, 이를 통해 프로젝트 내 클래스와 메소드의 사용법을 쉽게 공유할 수 있습니다.
- 주석 남용 방지: 주석은 간결하고 명확하게 작성해야 하며, 너무 많은 주석은 오히려 코드 가독성을 떨어뜨릴 수 있습니다.
요약
Java에서 주석은 코드를 설명하거나 참고 정보를 제공하는 중요한 도구입니다. 주석은 코드의 실행에 영향을 미치지 않지만, 코드의 가독성과 유지보수성을 높이는 역할을 합니다. Java는 단일 행 주석, 여러 행 주석, 문서화 주석을 제공하며, 각 주석 유형은 그 목적에 따라 사용됩니다. Javadoc을 통해 문서화 주석을 활용하면, 코드의 사용법과 설명을 자동으로 문서로 만들 수 있습니다.