지금까지 구현 주석을 알아봤습니다. 주석에는 구현 주석 외에도 문서를 만들 때 사용할 수 있는 문서화 주석이 있습니다. 문서화 주석도 조금 살펴보겠습니다.

코드에서 사용한 클래스가 뭐 하는 건지 클래스 내 메서드는 뭐 하는 건지 사용하는 사람이 쉽게 이해할 수 있도록 자바에서 문서화 코드를 만들 수 있습니다. 문서화 코드를 만드는 주석을 문서화 주석이라고 하며 코드의 명세 사항(specification)을 포함하며 자바 클래스, 인터페이스, 생성자, 메서드, 필드를 설명할 때 사용합니다. 아직 많은 내용을 학습하지 않아 다소 생소할 수 있습니다. 앞으로 배울 부분에 사용 설명서 같은 것을 만들어둘 수 있다고 이해하면 됩니다. 문서화 주석은 사용하는 프로그램에 따라 자동으로 나오거나 나오지 않을 수 있습니다. 안에 들어가는 내용도 달라집니다. 필요한 부분이 없다면 직접 입력해서 넣어주면 됩니다. 이 책에서는 우선 이클립스를 기준으로 설명하겠습니다.

문서화 주석은 ‘/**(슬러시별표별표)’로 시작해서 ‘*/(별표슬러시)’로 끝납니다.

HelloWorld 코드 중간에 ‘/**’를 넣고 Enter를 눌러보세요.

그림 4-3 | 문서화 주석