everydayminder
사실, 개발하면서 주석을 다는 것은 무척이나 흥미로운 귀찮은 일이다. 게다가 포맷을 지키고, 어떤 파라미터가 넘겨지고, 리턴 값은 어떻고, 어떤 상황에서 어떤 exception이 던져진다는 것까지 써야 한다면 더더욱 그렇다. 보통 프로그램부터 작성한 후, 주석을 달라고 한다면, 주석을 다는 것이 아주 하기 싫은 일이 될 가능성이 크다고 생각한다. 주석을 달면서, 코드 리뷰도 하고, 분석도 하고, 수정도 하는 선순환이 되기 보다는 상당히 형식적인 주석 작업이 될 확률이 더 높아진다. 오히려, 보다 양질의 주석을 달기에 좋은 시기는 해당 부분을 프로그램화 할 때라고 생각한다. 모든 프로젝트를 완료한 후, javadoc을 사용하는 대신에 초기부터 javadoc을 사용해 보자. 자신이 작성하는 코드와 비슷한 시..
작성한 자바코드를 표준 doclet의 javadoc으로 돌리면, package의 설명이 휑허니 빈칸으로 나온다. 어떻게 주석을 달면, package에 대한 설명을 넣을 수 있을까? package의 entry에 package.html을 작성해 주면 이 문제가 해결된다. 만약 package ab.cd.ef.* 가 존재한다면, 디렉토리가 ab/cd/ef가 존재할 것이다. 따라서, ab/cd/ef/pacakge.html을 작성해주면 javadoc 실행시 package의 description을 채워준다. 이 때, 작성 형식은 매우 간단하다. 다음과 같이 기록하기만 하면 body 부분의 설명이 그대로 반영된다.
www.doclet.com에 소개된 바와 같이 여러 종류의 doclet이 있으나, 그 중 몇몇은 javaodc의 출력 형태를 pdf로 직접 지정할 수 있다. LaTex를 쓰는 방법은 LaTex의 특성상 가독성이 좋은 결과물을 만들 것으로 기대되나, 별도로 변환을 한번 더 해줘야 하는 번거로움이 있으므로 이왕이면 손이 덜 가는 방법을 찾아보게 되었다. www.doclet.com에 소개된 library 중 하나인, AurigaDoclet(http://aurigadoclet.sourceforge.net/)을 사용해 보자. 사용법은 간단하다. ANT에서 지정할 수 있는 설정은, package-names package names source-path path of the java source files aurig..
