Chapter 01 자바를 시작하기 전에

3. 자바로 프로그램작성하기

3.4 주석(comment)

📌 주석(comment)

작성하는 프로그램의 크기가 커질수록 프로그램을 이해하고 변경하는 일이 점점 어려워진다.
심지어는 자신이 작성한 프로그램도 '내가 왜 이렇게 작성했지?'라는 의문이 들기도 하는데 남이 작성한 코드를 이해한다는 것은 정말 쉬운 일이 아니다.

이러한 어려움을 덜기 위해 사용하는 것이 바로 주석이다.
주석을 이용해서 프로그램 코드에 대한 설명을 적절히 덧붙여 놓으면 프로그램을 이해하는 데 많은 도움이 된다.

그 외에도 주석은 프로그램의 작성자, 작성일시, 버전과 그에 따른 변경이력 등의 정보를 제공할 목적으로 사용된다.

실제로 프로젝트에서 모든 파일에 위에 코드의 용도와 내용을 모두 주석으로 적는 파트가 있었다.
감자가 있던 파트는 Controller에서만 적었다.

또한 감자가 주석을 가장 많이 쓸 때는 코드를 수정하거나 오류난 부분을 찾을 때 일정 부분의 코드를 잠시 주석처리 해놓는다.

📌 주석 작성 방법

범위 주석

/*와 */ 사이의 내용은 주석으로 간주된다.

한 줄 주석

//부터 라인 끝까지의 내용은 주석으로 간주된다.

/*
	Description : Hello, World. 출력
    Author	: 말하는 감자
	Date	: 2022. 05. 22.
*/

class Hello {
	public static void main(String[] arg) { /* 프로그램의 시작 */
    	System.out.println("Hello, world."); // 화면에 Hello, world.를 출력
    }
}

📌 주의 사항

문자열을 의미하는 큰따옴표(") 안에 주석이 있을 때는 주석이 아닌 문자열로 인식된다.
그러므로 주석은 큰따옴표 밖에서 사용해줘야 한다.

class Hello {
	public static void main(String[] arg) {
    	System.out.println("Hello, /* 이것은 주석 아님 */ world.");
        System.out.println("Hello, world. // 이것도 주석 아님");
    }
}

<실행 화면>

---

📑 원본 자료

• Java의 정석(3판) [남궁 성/도우출판/2016]