1.5.1 주석 사용하기

주석은 프로그램 실행과는 상관없이 코드에 설명을붙인 것을 말한다.컴파일 과정에서 주석은 무시되고 실행문만  바이트 코드로 번역된다. 따라서 주석을 많이 작성한다고 해서 전체 프로그램의 크기가 커지는 것은 아니므로 가급적이면 설명이 필요한 코드에 주석을 달아 두는 것이 좋다. 복잡한 코드일수록 주석을 달면 전체 코드를 이해하기 쉽고, 수정이 용이하다. 특히 다른 사람이 작성한 코드를 주석 없이 해석하는 작업은 쉬운 일이 아니다. 본인이 작성한 코드를 다른 사람이 볼 필요가 있다면 주석을 꼭 넣어주는 것이 좋다. 주석의 내용에는 작성자, 작성일과 시간, 프로그램의 버전과 변경 이력 등의 정보, 주요 코드에 대한 설명 등이 포함된다. 코드에서 사용하는 주석문의 종류에는 다음과 같이 두 가지가 있다.


 주석 기호

 설명 

 // 

 //부터 라인 끝까지 주석으로 처리한다. (행 주석)

 /* ~ */

 /*와 */ 사이에 있는 모든 범위를 주석으로 처리한다. (범위 주석) 


주석문은 코드 내 어디서든 작성이 가능하지만, 문자열(" ")내부에는 올 수 없다. 문자열 안에서의 주석문은 주석이 아니라 문자열 데이터로 인식된다. 따라서 다음과 같이 주석을 붙이면 안 된다.

System.out.println("Hello, /*주석이 될 수 없음*/welcome to the java world!");

행 주석(//)과 범위 주석(/* ~ */)을 사용해서 Hello.java 소스 파일을 다음과 같이 수정해보자.



행 주석(//)과 범위 주석(/* ~ */) 외에도 자바 API 도큐먼트 문서에 포함되는 도큐먼트 주석(/** ~ */)도 있다. 도큐먼트 주석은 javadoc.exe 명령어로 API 도큐먼트를 생성하는데 사용된다.



1.5.2 실행문과 세미콜론(;)

실행문은 변수 선언, 값 저장, 메소드 호출에 해당하는 코드를 말한다. 실행문을 작성할 때 주의할 점은 실행문의 마지막에 반드시 세미콜론(;)을 붙여서 실행문이 끝났음을 표시해주어야 한다. 다음은 실행문을 작성한 예를 보여준다.



컴파일러는 세미콜론(;)이 나올 때까지 실행문이 계속해서 연결된 것으로 보기 때문에 한 실행문이 여러 줄에 걸쳐 있어도 되고, 한 줄에 여러 개의 실행문이 있어도 된다. 예를 들어, 앞의 코드를 다음과 같이 바꾸어 작성해도 전혀 문제가 없다.



지금으로써는 변수 선언이나 메소드 호출과 같은 실행문을 이해하는 것은 힘들지만 앞으로 이 책으로 학습하다 보면 저절로 알게 될 테니 걱정하지 않아도 된다. 실행문에 세미콜론(;)을 붙이는 연습을 할 겸 다음 소스 파일을 C:\Temp 디렉토리에 생성해서 실행해보자.




+ Recent posts