如何在JavaDoc中使用简单名称引用内部类方法?

时间:2015-09-06 17:54:36

标签: java reference javadoc

我想从文档中进行方法参考,但我知道如何以这种方式执行此操作{@link Main.MainInner.mainInnerMethod()},但在文档中,用户看到Main.MainInner.mainInnerMethod() - 它太长了。如果我希望用户(代码)仅查看mainInnerMethod()

,该怎么办?

我知道我可以执行此操作{@link Main.MainInner.mainInnerMethod() mainInnerMethod()},但如果我决定将mainInnerMethod重命名为someMethod,则用户将在文档中看到mainInnerMethod()而不是{ {1}},有没有办法获取方法的简单名称并将其放在文档中,所以如果重命名该方法,文档也会更新?

我只是感兴趣,在实际情况下我并不需要这个。

1 个答案:

答案 0 :(得分:4)

如果javadoc使用MainInner的另一种方法,那么您只需指定方法名称:{@link #mainInnerMethod()}

如果javadoc在其他地方,则必须至少提供类名。如果课程为import,则您不必对其进行限定:{@link MainInner#mainInnerMethod()}