[Java] 자바 주석

자바(Java)의 주석에 대해 알아보도록 하겠습니다.

 

 

---

 
ㅡㅡㅡㅡㅡㅡㅡ목차ㅡㅡㅡㅡㅡㅡㅡ

 
 
 
1. 자바의 주석
 
2. 주석의 종류

1. 한 줄 주석: //
2. 블럭 주석: /* */
3. Javadoc 주석: /** */

 

3. 주석의 활용

 
 

---

1. 자바의 주석

- 주석은 소스 코드 중 컴파일 시 무시되는 부분을 의미합니다.

- 컴파일 시 컴파일러는 소스 코드에 있는 주석 부분은 컴파일하지 않습니다.

- 소스 코드에 대한 설명이 필요한 경우 사용합니다.

- 소스 코드 중 일 부분을 수행되지 않도록 할 때 사용합니다.

---

2. 주석의 종류

2.1. 한 줄 주석: //

//: 한 줄 주석은 해당 라인 끝까지만 주석 처리됩니다.

// 이것은 한 줄 주석입니다.
String s = "한 줄 주석";

// 이것은 한 줄 주석입니다.
String s = "한 줄 주석";

 

 

2.2. 블럭 주석: /* */

/* */: 블럭 주석은 /*에서 */까지의 모든 내용이 주석 처리됩니다.

/* 이것은
   여러 줄의
   주석입니다. */
String s = "여러 줄 주석";

/* 이것은

    여러 줄의

    주석입니다. */

String s = "여러 줄 주석";

 

 

2.3. Javadoc 주석: /** */

/** */: Javadoc 주석은 코드에 대한 설명을 작성하거나, API 문서를 자동으로 생성할 때 사용됩니다. Javadoc 주석은 특별한 태그를 사용하여 추가 정보를 제공할 수 있습니다.

예를 들어, @param 태그는 메서드의 매개변수에 대한 설명을 제공하고, @return 태그는 메서드의 반환 값을 설명합니다.

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

/**

 * 이 메서드는 두 정수의 합을 계산합니다.

 *

 * @param a 첫 번째 정수

 * @param b 두 번째 정수

 * @return 두 정수의 합

*/

public static int add(int a, int b) {

    return a + b;

}

---

3.3 주석의 활용

3.1. 코드 설명

- 주석을 사용하여 코드가 수행하는 작업을 설명할 수 있습니다. 이는 코드를 처음 보는 사람이 코드를 더 쉽게 이해할 수 있도록 도와줍니다.

// 이 메서드는 두 정수의 합을 계산합니다.
public static int add(int a, int b) {
    return a + b;
}

 

 

3.2. TODOs 및 FIXMEs

- 주석을 사용하여 나중에 처리해야 할 작업이나 수정해야 할 버그를 표시할 수 있습니다.

// TODO: 이 메서드는 현재 정수만 처리할 수 있습니다. 실수 처리 기능을 추가해야 합니다.
public static int add(int a, int b) {
    return a + b;
}

 

 

3.3. 코드 비활성화

- 주석을 사용하여 특정 코드 라인을 임시로 비활성화할 수 있습니다. 이는 디버깅 중에 유용합니다.

public static int add(int a, int b) {
    // System.out.println("숫자 더하기");
    return a + b;
}