2017-01-12 35 views
0

我创建一个类A从onother类B继承,为什么eclipse不能识别一些javadocs标签?

我尝试也是B类的继承的javadoc的类A

所以我用的是如下因素标签:

/*** 
* {@inheritDoc} 
* @author 
* 
*/ 

但是Eclipse当我按下CTRL + SPACE不承认这个标签,并没有为类A显示文档。

任何机构有任何想法?

回答

4

这不适用于课堂评论。您只能在方法评论中使用它。

甲骨文的Javadoc documentation {上} @inheritDoc说:

此标记只在一个文档注释这些地方有效:

  • 在方法的主要描述块。在这种情况下,主要描述从层次结构中的类或接口复制而来。
  • 在方法的@return,@ param和@throws标记的文本参数中。在这种情况下,标签文本将从相应的 标签复制到层次结构中。
+0

@Yacine有一个很好的理由:两个类不应该有相同的类级别的javadoc。如果它们在功能和用途上是相同的,为什么有两个不同的类呢?另一方面,方法可能是同一个契约的多个实现,所以inheritDoc在那里是有意义的。 – VGR