JAVA 라인 주석 범위 주석 도큐먼트 주석 알아보기

주석은 프로그램 실행과는 상관없이 소스 코드에 설명을 붙여 놓은 것을 말합니다. 복잡한 코드 일수록 주석을 사용하는 경우가 많습니다. 당장 작성한 소스 코드는 주석을 사용하지 않아도 어떤 구조인지 이해 할 수 있겠지만 시간이 많이 지나면 잊어 먹기 마련입니다. 그래서 많은 시간을 소비하게 됩니다. 또 주석은 작성한 소스 코드가 어떤 버전이며, 작성일, 작정자, 프로그램 이름등 프로그램 정보를 달기 도합니다. 저와 함께 주석을 사용하는 방법을 살펴 보겠습니다. 이클립스를 실행하여 아래 그림과 같이 소스코드를 입력합니다.

주석의 종류가 다양하다는 것을 알 수 있습니다. 각 주석의 의미는 다음과 같습니다.

1. // 라인 주석을 의미하며 //부터 라인 끝까지 주석으로 처리됩니다.

2. /* ...*/ 범위 주석을 의미하며 /*와 */ 사이에 있는 내용은 모두 주석으로 처리됩니다.

3. /** ...*/ 도큐먼트 주석을 의미하며 /**와 */ 사이에 있는 내용은 모두 주석으로 처리되며 API문서를 생성합니다.

TIP

주석은 코드 내 어디서든 작성이 가능 하지만 문자열 내부에서 주석은 문자열 데이터로 인식하기 때문에 다음과 같은 코드는 사용할 수 없습니다.
System.out.println("Hello, /*주석이 될 수 없음*/");

2. 도큐먼트 주석을 살펴보겠습니다. 오라클사에서는 자바를 편히 작성 할 수 있게 다양한 API문서를 제공합니다. API문서란 오라클사에서 제공하는 클래스나, 패키지의 사용방법이라고 이해하시면 되겠습니다. 오라클사에서 제공하는 API문서가 아닌 사용자가 직접 API문서를 만들 수 있습니다. 어떻게 만드는지 저와 함께 살펴 보겠습니다.

JAVA 오라클사에서 제공하는 API 문서 보는 방법

이클립스에서 위와 같이 순서대로 진행합니다.

도큐먼트를 만들 프로젝트를 선택합니다. 저는 /** 처음 만드는 도큐먼트 주석입니다. */ 도큐먼트 주석을 가지고 있는 Test01 프로젝트를 선택하였습니다. 그리고 도큐먼트 생성위치를 잘 확인합니다.

Finish를 클릭하여 완료합니다.

도큐먼트 문서가 저장되어 있는지 지정된 경로를 확인합니다. 경로는 저와 다를 수 있습니다. index.html 파일을 실행합니다.

PACKAGE를 선택합니다.

위와 같이 도큐먼트 주석이 잘 만들어 진 것을 알수 있습니다. 도큐먼트는 오라클사에서 제공하는 것이 아닌 회사 또는 개인이 직접 클래스등을 만들어 참고 하거나 다른 곳에 납품을 할때 주로 사용합니다. 이상으로 JAVA 라인 주석 범위 주석 도큐먼트 주석 알아보기를 마치겠습니다. 긴 글 읽어주셔서 감사합니다.