2011-09-23 2 views
2

Eclipse를 사용하고 있습니다. 우선 오버라이드 된 메서드에서 만들어진 주석을 대신 표시하고 싶습니다. 나는 다음과 같은 Foo.ITEM.bar(...) 같은 것을 가지고 있고 그 위에 마우스를 가져 가면, 내가오버라이드 된 메서드에서 javadoc 주석을 표시하는 방법

바에게
인수에 접수되어야합니다 특정 인수를 읽을 수

enum Foo{ 
    ITEM{ 
     /** 
      * Arguments must be received in the following order... 
      */ 
     @Override 
     void bar(String[] args){...} 
    }; 

    /** 
     * Bars the specific args 
     * @param args the specific args 
     */ 
    abstract void bar(String[] arags); 
} 

- 여기

은 예입니다 다음 순서 ...
@args 특정 args

가능합니까?

답변

1

당신은 실제로 개별적인 enum 상수의 메소드에 Javadocs를 가질 수 있다고 생각하지 않습니다.

따라서 중요한 정보를 일반적인 방법 (예 : Foo.bar) 또는 개별 상수 문서 (Foo.ITEM)에 넣으세요. 개별 상수에 대한 메소드는 어쨌든 개별적인 주석을 필요로하는 것과 다르지 않아야합니다.

+0

나는 이것을 고맙게 생각한다. – mrkhrts

1

인터페이스 인 경우 인터페이스에 javadoc을 추가 한 다음 @Override 태그를 사용하면 표시됩니다.

1

내가 정확히 원하는 것을 이해하면 {@inheritDoc}이 대상입니다. 주석 본문이나 적절한 태그에 배치하여 수퍼 클래스/인터페이스 선언에서 주석을 가져옵니다.

Source과 관련 발췌 : 방법의

자동 복사가 Javadoc 툴은이 상황을 다음 아래 방법 클래스에 주석 및 인터페이스를 복사하거나 "상속"할 수있는 능력 을 가지고 댓글. 생성자, 필드 및 중첩 된 클래스는 문서 주석을 상속하지 않습니다.

텍스트를 자동 누락 기입 의견을 상속 - 메인 설명 또는 @return가 @param 또는 @throws 태그가 방법 주석, Javadoc 툴 복사 대응 메인 설명 또는 태그 주석에서 누락되면 아래 알고리즘에 따라 오버라이드하거나 (있는 경우) 메서드를 구현합니다. 좀 더 구체적으로, 특정 매개 변수에 대한 @param 태그가 누락 된 경우 에 대한 설명은 해당 매개 변수가 메서드에서 복사되어 상속 계층 에 추가됩니다. 특정 예외에 대한 @throws 태그가없는 경우 예외가 선언 된 경우에만 @throws 태그가 복사됩니다.

이 동작은 버전 1.3 및 이전 버전과 대조됩니다. 주 설명 또는 태그가 있으면 이 상속되지 않습니다.

명시 {} @inheritDoc 태그와 코멘트 상속 - 대응 상속 메인 설명 또는 태그 - 방법 메인 설명 또는 @return, @param 또는 @throws 태그 코멘트의 인라인 @inheritDoc 태그 {}를 삽입 댓글이 그 자리로 복사됩니다.

관련 문제