JavaDoc에서 재정의 된 메서드

JavaDoc에서 재정의 된 메서드

---

내가 개발 한 Java 프로그램을 문서화하고 있으며 수퍼 클래스를 문서화하는 경우 상속 된 메소드 (재정의 됨)에 대해 JavaDoc이 생성되는지 알고 싶습니까?

나는라는 클래스가있는 경우 Vehicle로모그래퍼 drive()의 방법 및라는 하위 클래스 Car으로 drive()대체 방법을 더 자바 독은 자동차 클래스에 넣어되지 않은 경우, 차량 구동 방법에 대한 설명서는 자동차 구동 방법에 포함됩니다?

---

수퍼 클래스를 문서화하면 상속 된 메소드 (재정의 됨)에 대해 JavaDoc이 생성되는지 알고 싶습니까?

예. 서브 클래스에 javadoc 주석이 없으면 수퍼 클래스 javadoc을 기반으로 javadocs가 생성됩니다.

서브 클래스에서 javadocs를 정의하면 상속 된 javadocs를 대체하지만 서브 클래스 javadocs에 각각의 수퍼 클래스 javadoc 주석 {@inheritDoc}을 포함 하는 데 사용할 수 있습니다 .

참고:

• https://docs.oracle.com/javase/6/docs/technotes/tools/solaris/javadoc.html#inheritingcomments

---

재정의 된 메서드의 JavaDoc을 사용하려면 {@inheritDoc}. F. e. :

/**
  * {@inheritDoc}
  */
@Override
public double getX() { ... }

거의 모든 재정의 된 메서드는 상위 문서를 상속합니다. :). oracle 문서 에서 읽을 수 있습니다 (@Steve Kuo 힌트에 감사드립니다).

Javadoc 도구는 다음 두 가지 상황에서 클래스 및 인터페이스의 메소드 주석을 복사하거나 "상속"할 수 있습니다. 생성자, 필드 및 중첩 클래스는 문서 주석을 상속하지 않습니다 ... (1) 누락 된 텍스트를 채우기 위해 주석 자동 상속 ... (2) {@inheritDoc} 태그를 사용하여 주석을 명시 적으로 상속

@see유사 / 중요 / ... 메소드를 참조하려는 경우 사용하십시오 . java.awt.Point수업의 예 :

 /**
 * Returns the location of this point.
 * This method is included for completeness, to parallel the
 * <code>getLocation</code> method of <code>Component</code>.
 * @return      a copy of this point, at the same location
 * @see         java.awt.Component#getLocation
 * @see         java.awt.Point#setLocation(java.awt.Point)
 * @see         java.awt.Point#setLocation(int, int)
 * @since       1.1
 */
public Point getLocation() { ... }

참조 URL : https://stackoverflow.com/questions/15905127/overridden-methods-in-javadoc