Javadoc을 이용해 주석을 달아보면 좋을 것 같다는 피드백을 많이 받아서 이참에 블로그에 정리해 보려고한다.
Javadoc
- 자바 코드에서 부가 설명이 필요할 때 사용함. 소스코드를 처음 보는 다른 개발자가 코드를 이해하기 더 수월하게 도와준다.
- JDK가 설치 되어있다면 사용할 수 있다.
- MVC 패턴으로 개발하는 환경에서 다른 클래스에서 메서드를 호출하는 경우가 많아 Javadoc 주석을 이용하면 메서드 위에 마우스를 가져다 놓는 것 만으로도 설명이 나와 어떤 메서드를 호출하는지 알기 쉽다.
예제
POST 방식으로 http://localhost:8080/schedules/{authorId} API를 호출하여 일정을 생성하는 부분이다.
메서드 네임 부분에 마우스를 올려두면 해당 메서드에 대한 설명들이 나오는 모습을 볼 수 있다.
Javadoc 태그
주석을 달아주고 싶은 부분 위에 /** 을 입력하고 엔터를 입력하면 Javadoc 주석을 작성할 수 있다.
그럼 많이 사용하는 것들을 위주로 Javadoc 태그들을 몇 가지 알아보자 !
@param
- 호출에 필요한 매개변수를 작성
@return
- 리턴값을 작성
@throws
- 발생시키는 예외를 작성
@see
- 참고할 만한 메서드, 외부 문서 링크를 첨부
@deprecated
- 곧 삭제 예정임을 표시
