代码之家  ›  专栏  ›  技术社区  ›  skaffman

是否有用于记录泛型类型参数的javadoc标记?

  •  149
  • skaffman  · 技术社区  · 16 年前

    我一直在浏览Sun网站上的JavaDoc文档,试图找出是否有一个JavaDoc标记可以用来记录类或方法的泛型类型签名。

    类似的东西 @typeparam ,和平常一样 @param ,但适用于类型和方法,例如

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

    我怀疑没有这样的标签——我在任何地方都找不到关于它的任何提及,JavaseAPI文档也没有显示任何迹象,但它似乎是一个奇怪的遗漏。有人能纠正我吗?

    2 回复  |  直到 8 年前
        1
  •  211
  •   Timo Willemsen    16 年前

    应该这样做:

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

    Source

        2
  •  25
  •   Boro    12 年前

    对。 只需使用@param标记,并在类型参数周围包含尖括号。

    这样地:

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