[토이/자바/JDBC] 커피숍 키오스크 만들기(9) : API 문서

 

Dao를 작성할 때 문서화 주석을 잘 달았다면 Javadoc을 통해 API 문서를 손쉽게 만들 수 있다.

이러한 문서가 있다면 내가 개발한 프로그램을 다른 개발자가 보았을 때 쉽게 이해할 수 있게 만들어준다.

 

아래는 프로젝트를 진행하며 만들어본 API 문서들이다. 각 메서드가 어느 클래스에 속하고 있는지, 어떤 파라미터와 어떤 리턴값을 가지는지 자세히 기술해놓았다. 또한 메서드 내부에서 트랜잭션, 혹은 DB에서 트리거가 발동하는 경우가 있다면 또한 함께 기술해두었다.