javadoc에서 메서드를 참조하는 방법?



Answers

javadoc 문서@link 섹션의 일반적인 형식은 다음과 같습니다.

예제들

같은 클래스의 메소드 :

/** See also {@link #myMethod(String)}. */
void foo() { ... }

동일한 패키지 또는 가져온 클래스다른 클래스 에있는 메서드입니다 .

/** See also {@link MyOtherClass#myMethod(String)}. */
void foo() { ... }

다른 패키지의 메소드 이고 가져 오지 않은 메소드 :

/** See also {@link com.mypackage.YetAnotherClass#myMethod(String)}. */
void foo() { ... }

메소드에 연결된 레이블, 코드 글꼴이 아닌 일반 텍스트로 표시 :

/** See also this {@linkplain #myMethod(String) implementation}. */
void foo() { ... }

귀하의 질문 마찬가지로 일련의 메소드 호출 . 이 클래스 외부의 메소드에 대한 링크에 대한 레이블을 지정해야하거나 getFoo().Foo.getBar().Bar.getBaz() . 그러나 이러한 레이블은 허약 할 수 있습니다. 아래의 "레이블"을 참조하십시오.

/**
 * A convenience method, equivalent to 
 * {@link #getFoo()}.{@link Foo#getBar() getBar()}.{@link Bar#getBaz() getBaz()}.
 * @return baz
 */
public Baz fooBarBaz()

레이블

자동 리팩토링은 라벨에 영향을 미치지 않습니다. 여기에는 메소드, 클래스 또는 패키지의 이름 변경이 포함됩니다. 메소드 서명 변경

따라서 기본값이 아닌 다른 텍스트가 필요한 경우 에만 레이블을 제공하십시오.

예를 들어, 인간 언어에서 코드로 링크 할 수 있습니다.

/** You can also {@linkplain #getFoo() get the current foo}. */
void setFoo( Foo foo ) { ... }

또는 위의 "메서드 호출 체인"에 표시된 것처럼 코드 샘플을 기본값과 다른 텍스트로 연결할 수도 있습니다. 그러나 API가 발전하는 동안 이것은 약해질 수 있습니다.

지우개 및 #member 입력

메소드 서명에 매개 변수가있는 유형이 포함되어 있으면 javadoc 링크에서 해당 유형의 삭제를 사용하십시오. 예 :

int bar( Collection<Integer> receiver ) { ... }

/** See also {@link #bar(Collection)}. */
void foo() { ... }
Question

@link 태그를 사용하여 메소드에 링크하려면 어떻게해야합니까?

나는 바꾸고 싶다

/**
 * Returns the Baz object owned by the Bar object owned by Foo owned by this.
 * A convenience method, equivalent to getFoo().getBar().getBaz()
 * @return baz
 */
public Baz fooBarBaz()

/**
 * Returns the Baz object owned by the Bar object owned by Foo owned by this.
 * A convenience method, equivalent to {@link getFoo()}.{@link getBar()}.{@link getBaz()}
 * @return baz
 */
public Baz fooBarBaz()

하지만 @link 태그를 올바르게 포맷하는 법을 모르겠습니다.




Related