더북(TheBook)

2.7 문서화 주석


JDK에는 javadoc이라는 아주 유용한 도구가 있다. javadoc은 소스 파일로 HTML 문서를 만든다. 사실 1장 기본 프로그래밍 구조에서 설명한 온라인 API 문서는 표준 자바 라이브러리의 소스 코드에 javadoc을 실행한 결과다.

소스 코드에 구분자 /**로 시작하는 주석을 추가하면 온라인 API 문서처럼 전문가 수준의 문서를 손쉽게 만들 수 있다. 문서화 주석은 코드와 문서를 한곳에서 볼 수 있는 아주 훌륭한 접근법이다. 예전 어려웠던 시절에는 프로그래머가 문서를 별도의 파일에 보관했기 때문에 코드와 주석이 달라지는 것은 시간 문제였다. 문서화 주석이 소스 코드와 같은 파일에 있다면 코드와 주석을 업데이트하고 javadoc을 다시 실행하면 그만이다.

신간 소식 구독하기
뉴스레터에 가입하시고 이메일로 신간 소식을 받아 보세요.