제네릭 형식 매개 변수를 문서화하기위한 javadoc 태그가 있습니까?

165

Sun 사이트에서 javadoc 문서를 살펴보면서 클래스 또는 메소드의 일반 유형 서명을 문서화하는 데 사용할 수있는 javadoc 태그가 있는지 확인하려고했습니다.

같은 뭔가 @typeparam평소와 비슷한, @param예를 들어, 유형뿐만 아니라 방법에 있지만 적용

/**
 *  @typeparam T This describes my type parameter
 */
class MyClass<T> {
}

나는 그런 태그가 없다고 생각합니다. 어디에서나 언급 할 수 없으며 JavaSE API 문서에는 아무런 흔적이 없지만 이상한 생략처럼 보입니다. 누군가 나를 제대로 넣을 수 있습니까?

java javadoc

— 스카프 맨
소스

적절한 javadoc을 작성하려면?

— Timo Willemsen

에 대한주의하십시오 대부분의 유형 매개 변수가 본질적으로는 객체의 메서드에 표시되는 방법에 의해 정의되기 때문에 클래스 정말, 형식 매개 변수에 대해 뭐라고 아무것도 재미가있다. 나는 @param <T>대부분의 시간을 건너 뛰고 정말로 명확하지 않을 때만 사용합니다.

— Kevin Bourrillion

나는 당신이 말하는 것을 알지만, 그 이론적 근거에 따르면 @param메소드 매개 변수 의 사용에도 동일하게 적용됩니다 . Sun의 코딩 표준에 따르면 @param, 메소드 매개 변수의 의미가 분명하더라도 사용해야한다고 명시되어 있습니다.

— skaffman

그 외에도. 좋은 API 프로그래밍은 가능한 한 자체 문서화되어야합니다. API에 문서가 필요하지 않다는 의미입니까? 아니.

— Timo Willemsen

@param 의 문서는 유형 매개 변수에 대한 지시 사항을 제공합니다. 오라클은이 문서를보다 효과적으로 광고 할 수 있습니다.

— Michael Allan

답변:

235

다음과 같이 수행해야합니다.

/**
 * @param <T> This describes my type parameter
 */
class MyClass<T>{

}

출처

— 티모 빌렘 센
소스

Doh .... 네, 당연하게도 당연합니다 ... JavaSE 클래스 (예 :)가 왜 그것을 사용하지 않는지에 대한 의문이 생깁니다 Collection.

— skaffman

LinkedList는 그것을 사용합니다 : java.sun.com/j2se/1.5.0/docs/api/java/util/LinkedList.html

— Timo Willemsen

@skaffman 물론 조금 늦었지만 질문을 제기 하지만 질문을 구걸 하지는 않습니다 .

— Thor84no

@ Thor84no 귀하의 링크에서 : 일부 당국은 "질문을 제기"하거나 "질문을 회피"하는 방식으로 "질문을 제기"하는 것이 더 이상 널리 사용되지 않기 때문에 더 이상 오해하지 않는 것으로 간주합니다.

— Matt R

이 경우 IntelliJ가 HTML처럼 완성되는 것은 부끄러운 일입니다.

— Snicolas

예. @param 태그를 사용하고 type 매개 변수 주위에 꺾쇠 괄호를 포함하십시오.

이처럼 :

/**
 *  @param <T> This describes my type parameter
 */

— 데이브 디 프랑코
소스