자바 튜토리얼 (1-2) 자바의 주석 표시 Comment

자바나 C 같은 프로그래밍 언어에는 주석을 사용할 수 있다.

 

주석은 영어로 Comment 이며 아래와 같이 사용한다

 

주석처리

자바의 컴파일러는 컴파일 시에 // 표시된 줄을 무시한다.

 

즉 프로그램의 실행과는 전혀 상관이 없다.

 

주석을 표기하는 이유는 컴파일러(컴퓨터)에게 지시하는 내용이 아니라

 

이 소스코드를 읽는 사람에게 필요한 정보를 남기기 위해서이다.

 

이 소스코드가 무슨 일을 하는지 나중에 소스코드를 수정해야 할 때 필요하다.

 

또 다른 사람이 작성한 소스코드를 읽을 때 유용하다.

 

주석을 다는 것은 이 소스코드를 읽는 다른 사람을 위해 쓸 수도 있다.

 

자칫 소스코드를 쓰다보면 나 혼자만 이해하는 방식으로 작성할 수가 있는데

 

주석을 사용하면 최소한의 힌트를 줄 수 있다.

 

지금 소스코드를 혼자서 쓰고 있지만 나중에 누가 나의 코드를 수정하고 싶을지도 모른다.

 

이 소스코드가 나만의 것이 아니라 모두의 것이라는 오픈소스의 정신을 갖는다면

 

소스코드는 유용한 커뮤니케이션 수단이라 생각한다.(혹은 동업자 정신으로)

 

책을 쓴다고 생각해도 좋고, 누군가에게 보내는 편지라고 생각해도 좋다.

 

형식은 // 를 사용해서 한줄 주석 처리하거나,

 

/* */ 를 사용해서 여러줄 주석 처리할 수가 있다.

 

여러줄 주석처리

주석에 뭘 담아야 할 지는 정해지지 않았다.

 

프로그램을 쓰는 당신이 남기고 싶은 정보를 담으면 된다.

 

혹시라도 이 소스코드를 나중에 볼 사람을 위해서 말이다.