우리는 JavaDoc 클래스가 추상 클래스를 확장해야합니까?

Question

"Work"추상 클래스를 확장하는 "MyWork"클래스를 작성한다고 가정합니다. 자, "MyWork"에 필요한 모든 메소드가 이미 선언되었고 JavaDoc이 "Work"로 작성되었다고 가정합니다. "MyWork"에 JavaDoc을 추가해야합니까?

건배!

Answer 1

MyWork의 메서드가 Work의 모든 기능을 재정의하지 않으면 메서드가 해당 슈퍼 클래스와 비슷한 동작을하는 것으로 가정하는 것이 안전합니다. 오버라이드되지 않은 메소드 나 필드를 문서화 할 이유가 없어야합니다.

Answer 2

"MyWork"클래스가 추상 메소드를 오버라이드 할 필요가 있다고 가정합니다.

특별한 동작이없는 경우 새 JavaDoc을 추가하지 않아도됩니다. 그렇지 않으면 추상 메소드를 구현하는 방법을 문서화하십시오. 일반적으로이 메소드가 추상 클래스이고 상속 클래스에 구현되어야하며 추상 클래스 자체에는 구현되지 않은 이유가 있어야합니다.

{@inheritDoc}을 사용하면 상속 된 Doumentation의 텍스트를 가져온 다음 그 아래에 특수한 동작을 추가 할 수 있습니다.

Answer 3

다릅니다. 메소드를 오버라이드 (override)하지 않는 경우, Javadoc를 추가하는 옵션은 없습니다 (클래스 레벨에서만). 왜 존재하는지 설명하는 클래스에 Javadoc을 추가하는 것이 합리적 일 수 있습니다. 당신이 방법을 재정의하는 경우

,이 같은 자바 독을 작성할 수 있습니다

/** 
* {@inheritDoc} 
* This implementation also does... 
*/ 

Answer 4

비공개 코드, 나는 @inheritDoc는 처리하지 않습니다 아무것도 신경 쓰지 않을 것입니다.