39
{@inheritDoc} 클래스를 사용하여 내 추상 클래스의 메서드를 상속합니다. 추상 클래스의 문서에서 이름으로 추상 클래스를 참조합니다. 서브 클래스가 슈퍼 클래스의 문서를 상속 할 때 이것을 어떻게 태그 할 수 있습니까? 추상 클래스의 이름을 서브 클래스의 이름으로 바꿉니 까?Javadoc {@inheritDoc} 태그 클래스
A
답변
44
설명하는 내용은 javadoc 생성 도구에서 지원하지 않습니다.
그리고 나는 좋은 이유도이 거기에 있다고 생각 :
서브 클래스에 메소드는 단지 추상 메소드의 구현 경우, 나는 추상 클래스를 떠나 올바른있을 거라고 생각 거기에 이름이있어.
반대로, 서브 클래스의 메소드가 단순한 구현이 아니고 주목할만한 것 (javadoc에서 언급 할만큼 충분히)을 수행하는 경우, 다음 메소드에서 새 javadoc을 작성해야합니다. inheritDoc를 호출하는 대신 서브 클래스를 호출하십시오.
15
나는 방법을 알지 못하지만, 당신이 왜 {@inheritDoc}을 원하게되는지 상세히 설명 할 수 있습니다. 나는 오해 할 수도 있지만 혼동스러워 보인다. 구체적인 구현이 부모로부터 어떻게 달라지는 지 문서화하고 @see을 사용하여 추상 클래스에서 계약을 참조하십시오. 참고 "Automatic Copying of Method Comments"은 명시 적으로 {@inheritDoc}의 필요성을 없앨 수 있습니다.
+0
나는 알고 있다고 생각합니다. 감사. – LandonSchropp
0
고객님의 의견에 따라 {@inheritDoc} 태그 주위에 추가 텍스트를 쓸 수도 있습니다.
이것에 대한 나의 추론은 내 코드의 독자가 일반적으로 구현 뒤에 추상 클래스를 보지 않을 것이므로 그것을 숨기고 싶었다. 그러나, 나는 이것을 할 수없는 것으로 보입니다. 어쨌든 고마워. – LandonSchropp
클래스의 사용자가 메소드에 대한 문서를 필요로하지만 추상 기본 클래스의 존재에 대해 알지 못하는 경우, 메소드 정의를 추상 클래스에있는 javadoc과 함께 인터페이스로 이동해야합니다. 본질적으로, 인터페이스는 사용자가 케이스에 대해 이야기 할 것입니다. 위의 대답에있는 두 점은 여전히 적용됩니다. – GreenGiant