4장. 컴퓨터가 읽지 않는 문자, 주석

이전 장들...

1장. 개발환경 세팅하기 (java, eclipse)

2장. Eclipse 기본 사용법

3장. 자바 메인 메소드, 기본 출력

이번 포스팅에서는 '주석'이라는 것에 대해서 이야기해 보려고 한다.

주석은 문법적인 것은 아니지만, 문법 못지않게 중요하게 사용된다. 하지만, 이제 프로그래밍을 갓 시작하는 독자이거나, 개인적으로 소규모 프로젝트를 진행하실 독자이신 경우 이 내용이 그리 마음에 와 닿지는 않을 것 같다는 생각이다.

주석이란?

제목에서도 알 수 있듯, 컴퓨터가 읽지 않는 문자를 '주석'이라고 한다. 즉 프로그래머가 코드를 타이핑하여 컴파일 (컴퓨터가 코드를 실행 가능한 파일로 변환하는 과정) 하는 과정에서 특정 기호를 붙인 뒤 무언가를 입력하게 되면 컴퓨터는 해당 기호가 붙은 무언가를 읽지 않게 된다.

어떨 때 필요할까?

앞서 주석은 '컴퓨터가 읽지 않는 문자'라고 정의하였다. 그러면 컴퓨터가 읽지도 않는데 왜 '주석'이란 게 있으며 왜 쓸까?

주석 사용의 주 목적은 다음 몇 가지에 있다.

1. 해당 코드의 용도 및 목적이 무엇인지 파악하기 위해 사용한다.

2. 다른 개발자가 진행 중이었던 프로그램을 넘겨받을 때 해당 코드들의 이해를 쉽게 하기 위해 사용한다.

주석이란 것은 개인 프로젝트나 규모가 그리 크지 않은 프로젝트의 경우에는 큰 의미가 없을 수 있지만, 회사 내에서 팀프로젝트를 할 때에는 없어서는 안 될 필수불가결의 요소가 된다.

아직 Java 의 문법은 배우지 않았으니 예시는 생략하도록 하겠다.

그렇다면, 어떻게 사용할까?

주석의 경우 코드 내에서 특정 코드를 주석 처리하거나 코드에 부가적인 설명을 작성할 때에 대부분 사용된다.

주석의 표시 방법은 다음과 같다. (블록 주석문과 단일 주석문이 있다.)

블록 주석문의 경우, /* 와 */ 사이에 작성하는 모든 글자가 주석 처리되고 (엔터 포함)

단일 주석문의 경우, // 다음에 작성하는 글자들이 주석 처리된다 (엔터 제외, 해당 줄만 처리됨)

왜 종류가 두 가지일까?

주석의 종류가 두 종류이니, 사용되는 목적도 두 종류가 아닐까 하는 생각이 들 수 있다.

블록 주석문의 경우 클래스 파일 최상단에 해당 클래스 파일이 어떤 역할을 하는 파일인지나, 파일을 누가 생성하고 누가 마지막으로 편집했는지, 최초 생성일은 언제인지 등을 표시하는 데에 쓰인다. (실제 실무에서 필수적으로 쓰이는 요소이다.)

단일 주석문의 경우 코드 옆에 이 코드가 무슨 역할을 하는지 간단히 기술하는 용도로 쓰인다. 이 코드가 무슨 역할을 하는지, 왜 여기에 기술되어 있는지 등을 간단하게 설명할 수 있는 역할이라고 할 수 있다.

---

주석의 경우 이 세상의 존재하는 (거의) 모든 프로그래밍 언어에 포함되어 있을 것이다. (주석문의 표현 방법까지 같다는 말은 아니다.)

그만큼 알면 좋다는 것이고, 다음 장에서, 진짜 프로그래밍의 시작을 '변수'라는 개념으로 시작해 볼 것이다.

5장 바로가기 >>