2013-06-18 2 views
1

오버로드 된 메서드를 사용하여 문서를 만드는 가장 좋은 방법을 찾고 있습니다.오버로드 된 메서드에 대해 동일한 문서를 가져올 수 있습니까?

나는 두 가지 방법이 있습니다 : 두 방법 모두 같은 일을 렌더링하기 때문에

/** 
* does something 
* @param A 
* @return result 
*/ 
public String methodA(Type1 A); 

/** 
* does something 
* @param A 
* @return result 
*/ 
public String methodA(Type2 A); 

을, 그것은 개체 인수를 할 방법 느릅 나무에 문서를 중앙 집중화 할 수 있습니까? 아니면 그렇게 할 수있는 더 좋은 방법이 있습니까?

+1

javadoc에 대해 이야기하고 있습니까? –

+0

당신은 generics를 사용할 수 있습니다. 그러나 이것은 문서를 중앙화하기 위해 약간 무거운 것이라고 생각합니다! –

+0

@ Shreyos Adikari 예, JUnit과 함께합니다. – fxm

답변

1

일종의 "일반적인"문서를 쓰려는 원래의 의도는 기본적으로 작동하지 않는다고 생각합니다. 최소한 매개 변수와 반환 값을 처리해야합니다.

아니면 더 좋은 방법이 있습니까?

실제 문서의 중복을 피하려면 @link 태그를 사용할 수 있습니다.

이 방법은 많은 방법의 문서 (예 : Properties.load() 방법)가 필요한 경우에 특히 유용합니다.