팀과제가 끝나고 KPT회고를 하며, 뛰어난 실력으로 팀을 이끌어준 팀원분의 피드백이
'주석좀 달아요!'였다. 팀원분이 굉장히 주석을 깔끔하게 달아놓으셔서 나도 카피해서 쓰긴했다ㅎ
그분이 Javadoc이란걸 알려주셔서 한번 알아봤다.(Controller에서만 사용 가능하다고 일러주셨다.)
/**
* @apiNote : blahblah
* @param id, pw
* @return members
* @thorws
*/설명을 적고 싶은 메소드, 클래스, 인터페이스 위에서 /** 을 치고 엔터를 누르면 위와같은 양식을 만들 수 있다.
@apiNote : API에 대한 설명
@param : API메소드의 인자값에 대한 설명을 추가
@return : 리턴값에 대한 설명
@thorws : 발생시키는 오류에 대한 설명
@see class_name#method_name : 관련된 메소드 링크 추가
@deprecated : 삭제예정
.