오버로드 메소드에서 Javadoc을 작성하는 건조한 방법


9

DRY 방식으로 Javadoc을 작성하고 싶습니다. 그러나 Javadoc 에 대한 오라클 문서 는 과부하 방법 주석에서 동일한 것을 다시 작성한다고 말합니다. 반복을 피할 수 없습니까?

답변:


3

{@inheritDoc}수퍼 클래스에서 메소드를 대체하거나 인터페이스 정의 메소드를 구현할 때 Javadoc 주석에 지시문을 뿌 립니다.

이것은 적어도 나를 위해 잘 작동하고 소스 코드에서 반복을 피하고 필요한 경우 특정 Javadoc 주석에 특정 정보를 추가 할 수 있습니다. 괜찮은 IDE에서 필요한 모든 것이 관련 식별자 이름 위로 마우스를 가져 와서 렌더링 된 Javadoc을 참조 및 모두 가져 오는 경우 Javadoc 주석 자체가 문제가되지 않는다는 사실을 고려하지 않습니다.


2

문서의 요점은 항목의 향후 사용자를 밝히는 것입니다. 이것은 부분적으로 저자의 편의를위한 것이며, 누군가가 어떻게 작동하는지 알 수 없을 때마다 연락 할 필요가 없습니다. 그러나 대부분은 물건을 사용하거나 지원 해야하는 사람들의 이익을위한 것입니다.

따라서 저자의 편의와 반대로 요점은 명확해야합니다. 본질적으로 자신을 반복하기에는 너무 게으 르기 때문에 사람들이 API 문서를 찾거나 내릴 것을 기대할 수 없습니다. 빨라 --Javadoc은 반복적이다.

즉, 영리한 경우 마커 또는 다른 기준에 따라 코드에 주석을 추가하는 프로그램을 작성할 수 없습니다. 가치보다 문제가 될 수 있습니다. 아님


4
아니요, 반복하지 마십시오. 모든 것을 동기화하는 것이 훨씬 더 많은 오버 헤드입니다. 오버로드 된 구현에 대한 새로운 정보가 있다면 그 정보 만 쓰십시오. 필자는 유형의 사용자가 수퍼 유형의 javadoc을 볼 것으로 기대하는 것이 합리적이라고 생각하며 Eclipse와 같은 도구를 사용하면 매우 쉽습니다.
Dawood ibn Kareem
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.