在Eclipse中,如何在Javadocs中显示泛型类型约束?

时间:2012-03-28 13:44:13

标签: java eclipse generics constraints javadoc

在Eclipse中,当您将鼠标悬停在元素上时,只显示Javadoc,以及元素的(不受约束的)签名。

假设我有class X <T extends Object> {}。如果我使用Eclipse的Javadoc生成器,我得到:

/**
 * @param <T>
 */ 

渲染的Javadoc看起来像这样。注意缺少类型约束信息。

    com.domain.X<T>        Parameters:           <T>

有没有办法在Eclipse中显示Javadoc查看器的泛型类型约束?

2 个答案:

答案 0 :(得分:2)

我输入Eclipse bug/enhancement来解决此问题。令人难以置信的是,Markus Keller实际上在提交后3-4小时内实施/修复了这个问题!

答案 1 :(得分:0)

班级的正文已经说T extends Object,你在javadoc中不需要它。

在记录事物时(代码或javadoc中的注释等),请遵循以下2条规则:

  • 不要重复。如果你不遵循这一点,那么保持评论和代码同步将会困难得多。
  • 不要记录明显的内容。您的代码的读者知道该语言。不是解释你做了演员,而是解释为什么你做了演员。