2009-04-02 4 views
21

매우 잘 설명 된 인터페이스를 생성했습니다. 모든 메소드에는 자체 JavaDoc이 있습니다. 이 인터페이스를 구현하는 clases는 로직에 약간의 차이가있을 수 있습니다.새로운 JavaDoc을 수퍼 메소드에서 기존에 추가

수퍼 클래스에서 기존 JavaDoc에 JavaDoc을 어떻게 추가 할 수 있습니까? 키워드

/** 
* {@inheritDoc} 
*/ 

현재 메서드에 슈퍼 클래스의 javaDoc 만 설정합니다. 내가 일부 단어를 추가 할 때, 슈퍼 방법의 JavaDoc을 아무도 내가 삭제하지 않고, 슈퍼 방법의 JavaDoc을 업데이트 할 수 있습니다 어떻게 생각을 가지고 있습니까

/** 
* {@inheritDoc} 
* These value depends on... 
*/ 

처럼 사라졌다.

편집

: 좋은하지만 진짜 대답 브라이언 애그뉴의 대답에 관해서는

)

기존 방법을 덮어 쓸 때 당신은 또한 페인트처럼, 같은 문제를 가질 수 있습니다()를 사용하여 외부에서 그리기 동작을 초기화하거나 처리하는 방법을 설명하고자합니다. 이것은 인터페이스 설명을위한 것은 아닙니다.

+6

설명한 문제는 Java 7에서 수정 된 것 같습니다. 제안 된 코드는 꽤 잘 작동합니다. – ubuntudroid

+0

좋은 질문입니다. 오늘 매우 유용한 것을 배웠습니다. 인터페이스를 문서화하는 데는 완벽합니다. 모든 자식은 문서를 상속 해 자신의 내용을 추가합니다. 예를 들어, 약간의 예외가 throw되어 Javadoc에 단일 @ @ throws를 추가 할 필요가있는 구현이 있습니다. – Timmos

답변

12

javadoc에 뭔가를 추가해야 할 때 뭔가 바뀌었을 것입니다. 어쩌면 정확히 같은 방식으로 javadoc을 작성하는 것이 맞을 수도 있습니다.

/** 
* Enhanced swing paint for my cool component. 
* @see JButton#paint(); 
*/ 
@Override 
public void paint() { 
    super.paint(); 
    //my stuff 
} 
2

직접적인 JavaDoc 관용구를 알지 못합니다. 그러나 이클립스와 IntelliJ는 슈퍼 JDoc을 잡아서 삽입 할 수있게 해줄 것입니다 ... 완벽하지는 않습니다. supr JDoc을 변경하면 오버라이드를 모두 다시 작성해야하지만 손으로 ​​복사하여 붙여 넣는 것보다 낫습니다.