1.3.6 주석

주석은 소스 코드에 프로그램으로 인식되지 않게 정보를 메모해둘 때 사용한다.

예를 들어 특정 코드가 무슨 일을 하는지 자연어로 남길 수 있다. 다음 3가지 방식으로 주석을 작성할 수 있다.

- 한 줄 주석

- 여러 줄 주석

- 문서(Javadoc) 주석

한 줄 주석

// 이후부터 줄을 바꿀 때까지 주석으로 처리되어 프로그램으로 해석되지 않는다.

예를 들어 다음 코드에서 굵은 글씨 부분이 주석이다.

한 줄 주석

---------------------------------------------------------------------------------------------------------------------------

// 한 줄 주석의 예이다.

int index = 0;; // 여기부터 이 줄 끝까지 주석으로 처리된다.

String value = "abc";

---------------------------------------------------------------------------------------------------------------------------

 이클립스에서는 여러 행을 선택하고 Ctrl + / 키를 누르면 선택한 행 모두를 한 줄 주석으로 코멘트 아웃 할 수 있다.

 여러 줄 주석

/*와 */ 사이에 기술된 내용을 주석으로 다룬다. 중간에 줄바꿈을 포함할 수 있어 여러 행을 모아 주석 처리하는 데 이용한다. 사용하지 않게 된 메서드를 /*와 */ 로 에워싸 일시적으로 사용할 수 없게 하는 용도로 쓸 수도 있다. 다음처럼 기술한 경우 굵은 글씨 부분이 주석이다.

여러 줄 주석

----------------------------------------------------------------------------------------------------------------------------

/*

여러 행을 묶어 주석으로 처리한다.

이 안에 기술된 내용은 주석으로 다루어져 프로그램으로 해석되지 않는다.

*/

int index = 0; /* 이렇게 한줄로도 가능하다. */

/*

이 메서드는 실행되지 않는다.

public void doSomething(){

System.out.println("주석 샘플");

}

*/

----------------------------------------------------------------------------------------------------------------------------

문서 주석

자바에는 주석을 바탕으로 클래스와 메서드 등에 관한 설명을 HTML 형식으로 출력해주는 기능이 있다. 이 문서를 Javadoc이라고 부른다.

Javadoc 문서의 바탕이 되는 주석이 Javadoc 주석이다. HTML문서가 되므로 이 주석안에서 HTML 태그를 사용하면 결과 문서에서는 문자가 아니라 HTML 태그로 인식된다.

이 주석은 클래스나 필드, 메서드 앞에 /** ~ */ 형식으로 나타낸다. 좀 전에 작성한 HelloWorld 애플리케이션에 Javadoc 주석을 삽입하면 다음과 같다. 굵은 글씨 부분이 Javadoc 주석이다.

Javadoc 주석

----------------------------------------------------------------------------------------------------------------------------

package jp.co.bbreak.sokusen._1._3;

/**

* 화면에 'HelloWorld!!'라고 출력하는 클래스입니다.

*/

public class HelloWorld {

/**

Helloworld 클래스를 java ㅁㅇ령으로 호출했을 때 실행되는 처리입니다.

@param args

명령 줄 인수 . 이번에는 사용하지 안흔ㄴ다.

*/

public static void main(String[] args_ {

System.out.println("hello world!!");

}

}

----------------------------------------------------------------------------------------------------------------------------

main 메서드 주석에 @param 이라는 키워드가 등장했다. 이 키워드를 태그라고 부르며 @ ㅐ형식으로 주석에 의미를 부여할 수 있다. @param은 메서드에서 사용되는 인수를 나타낸다.

Javadoc 주석에는 몇 가지 태그가 있다. @param 외에도 메서드 반환값을 설명하는 @return 태그도 자주 사용한다.

업무 애플리케이션을 개발할 때는 여러 사람이 작업하거나 개발에 관련되지 않은 사람이 애플리케이션을 관리하는 일이 많으므로 다른 사람과 의사소통할 일이 많다. 또한 자신이 만든 프로그램이더라도 몇 년쯤 지나면 어떤 의도로 그렇게 작성했는지 잊어버리기도 한다.

javadoc 주석을 넣어두면 프로그램이 무슨 일을 하는지 파악하기 쉬워진다. 최소한 메서드와 필드에는 Javadoc 주석을 넣어두도록 하자.