【问题标题】:JavaDoc: Reduce redundancy for Repeated Method Descriptions within the Same ClassJavaDoc:减少同一类中重复方法描述的冗余
【发布时间】:2013-09-18 13:28:46
【问题描述】:

例如,我有两个方法,public Tree<T> addChild(final T data) {}public Tree<T> addChild(final T... data) {},它们的 JavaDocs 是相同的。如何将/** method description */ 放在其中一个中,并使用标签将另一个JavaDoc 引用到前一个?

就像,在概念上:

/**
 * method description
 */
public Tree<T> addChild(final T data) { ... }

/**
 * @theTag #addChild(Object)
 */
public Tree<T> addChild(final T... data) { ... }

如果我没记错的话,我曾经偶然遇到过一个标签,它导入了 Java 原生 API 方法的整个方法描述。所以,应该是可以的。

@theTag 是什么?非常感谢!

【问题讨论】:

  • 你可能在想如果@inheritDoc,它不会做你想做的事。

标签: java eclipse comments javadoc block-comments


【解决方案1】:

@see 标签怎么样?它不是完全导入,而是放置参考:

/**
 * action 1 description
 */
public void action1(){}

/**
 * @see MyClass#action1
 */
public void action2(){}

【讨论】:

  • 感谢您的回答。但是@see 只是在气泡中有一个链接。这还不够好:-/
  • 恐怕在裸 javadoc 中没有比这更好的了。只有 {@inheritDoc} 复制整个描述,但它只适用于实现或覆盖的方法。
  • 哦,是的!我遇到的是/* (non-Javadoc) * @see java.lang.Object#equals(java.lang.Object) */ @Override public boolean equals(Object obj) { ... }。我刚刚尝试了一段时间,它似乎只适用于继承的方法,如你所说。
猜你喜欢
  • 2019-06-20
  • 2014-08-28
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2018-12-19
  • 2020-11-05
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多