如何在api类和它的实现之间链接javaDocs?

时间:2016-06-02 09:29:48

标签: java intellij-idea comments javadoc

我正在努力让java Docs显示在类的实现方面。 我有一个api类,其中所有文档都驻留在实现端并且没有显示出来。我已经看到它通过Eclipse工作,但我们的公司标准是IntelliJ。 我无法找到关于从api到实现的文档链接的信息,所以我希望能得到一些关于如何实现这一目标的帮助

实施例 API类

public interface Builder {
/**
 * Adds an interaction to the agents latest interaction.
 * It is stored inside the cahce
 * If the interaction already exists in the list it is moved from its position to the top
 * If the interaction does not exist in the list the eldest interaction is removed and the
 * new interaction is added to the top
 * @param interaction
 * @param amountOfAgentPreviouseInteraction
 */
public void updateInteraction(Interaction interaction, int amountOfAgentPreviouseInteraction);
}

enter image description here

这是我实施方面的java文档

enter image description here

并且实现确实实现了api类

@Named
public class BuilderImpl implements Builder {
public void updateInteraction(Interaction interaction, int amountOfAgentPreviouseInteraction){
//Some logic here
}

}

我也尝试了@link@see

这似乎是一项非常简单的任务,但我无法找到解决方案。

感谢您的时间

编辑:好的,所以我忘了提到api和实现不在同一个项目中。

1 个答案:

答案 0 :(得分:0)

请尝试在方法实施的文档评论中使用{@inheritDoc}