[JAVA] 주석(Comment)

주석

소스코드에 영향을 주지 않고(컴파일 시 영향을 주지 않고) 작성한 코드 내에 설명을 달기 위해 사용하며, 한 줄 주석(라인 주석), 여러 줄 주석(블록 주석), 문서 주석 세 가지 종류가 있다.

 

1. 한 줄 주석 (라인 주석)

// 기호를 이용하며, // 기호가 시작된 곳부터 해당 라인의 끝까지 주석으로 간주한다.

변수에 대한 설명이나 코드의 특정 부분에 대해 설명이 필요한 경우 라인 주석을 사용한다.

int num; // 숫자를 저장하는 인트값입니다.

// num 값이 0인 경우 출력!
if(num == 0){
	System.out.println("0입니다.");
}

 

2. 여러 줄 주석(블록 주석)

/* 기호를 사용하여 블록 주석의 시작을 정하고, */ 기호를 사용하여 블록 주석의 끝을 정한다.

메서드(Method), 클래스(Class), 한 줄로는 표현할 수 없는 많은 양의 설명이 필요한 경우 블록 주석을 사용한다.

private int num = 0;

/*
 num 값을 리턴하는
 함수힙니다.
*/
public int getNum(){
	return num;
}

 

3. 문서 주석

/** 기호를 사용하여 문서 주석의 시작을 정하고, */ 기호를 사용하여 문서 주석의 끝을 정한다.

블록 주석과 쓰이는 곳은 동일하지만 차이점이 있다면, javadoc 툴을 사용하여 html 파일로 추출 가능한 점이다.