IT박스

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

itboxs 2020. 6. 2. 19:06
반응형

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


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

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

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

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


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

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

}

출처


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

이처럼 :

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

참고 URL : https://stackoverflow.com/questions/2015972/is-there-a-javadoc-tag-for-documenting-generic-type-parameters

반응형