如何记录泛型类型参数？

Question

假设下面是一个通用类型，我应该使用什么来代替 ??? 来正确记录 T？

/**
 * ??? The description of T.
 */
class MyClass<T> {
}

在 C# 中我会使用 <typeparam>。是否有官方的 JSDoc 等价物？

Answer 1

VLAZ 在评论中指出 @template 有效但未在官方 JSDoc 文档中提及。然而，在 Typescript 自己的 JSDoc 参考中提到了它 (link):

You can declare type parameters with the @template tag. This lets you make functions, classes, or types that are generic:

示例：

/**
 * Description of the class MyClass.
 * 
 * @template T Description of the type parameter T.
 */
class MyClass<T> {
    constructor(public readonly x: T) {}
}

当我将鼠标悬停在构造函数中出现的 T 上时，文本 "Description of the type parameter T." 出现在 Typescript Playground 中，所以这样做似乎有效。

Playground Link

如何记录泛型类型参数？

How to document generic type parameters?

jsdoc

typescript