javadoc custom tag 사용하기

간만에 javadoc을 사용하여 산출물을 제출해야하는 상황이 되었습니다.

기존에 다른 프로젝트에서 사용하던 formatter가 있어 이를 활용하여 열심히 주석을 작성했습니다.

(다른 개발자 공유하여 같은 형식으로 작성함.)

 

어느정도 작성이 되어 eclipse에서 javadoc export 하였습니다.

그런데, 결과물이 아래와 같이 좀 이상하더군요.

1. 몇몇 tag가 추가된 주석이 사라지는 현상과

2. Spring Controller method의 @Param 등과 같이 메소드 아규먼트에 annotation이 추가된경우 javadoc html 이 깨지는 현상 ( 문서 밖으로 튕겨져 나감 )

 

1. 해결 : -tag옵션을 사용합니다. 

tag Description:a:"Description:" -tag Method:a:"Method:" -tag Copyright:a:"Copyright:" 

사용법 : -tag  tagname:Xaoptcmf:"taghead"
X (태그의 무효화)
a (모든 위치)
o (개요)
p (패키지)
t (형태 즉 클래스 및 인터페이스)
c (constructor　 　 )
m (메소드)
f (필드)

 

2. 일단은 spring sts에서 javadoc compile 하여 해결

  doclet 을 이용하면 될듯 하지만 시간상... 패스

 

 

그외 javadoc 활용법은 아래 링크 참조

 

https://m.blog.naver.com/PostView.nhn?blogId=idtong&logNo=130046468963&proxyReferer=https%3A%2F%2Fwww.google.com%2F

이클립스내 주석 자동 달기