相关疑难解决方法(0)

Javadoc @see或{@link}?

有人能告诉我javadoc @see{@link}?之间的区别吗?

或者更确切地说,何时使用它们中的哪一个?

java javadoc

176
推荐指数
4
解决办法
9万
查看次数

用@see编写正确的javadoc?

如何@see正确使用javadoc?

我的目的是使用抽象方法创建一个抽象类.这些方法有javadoc注释.现在,如果我扩展抽象类,我会覆盖方法并想要使用@see.

但对于所有的参数,可以如用于return@see链接似乎并没有工作.Eclipse仍抱怨expected @return tag.

那我该怎么用?

public abstract class MyBase {
  protected abstract void myFunc();
}

class MyImpl extends MyBase {

  /**
   * @see MyBase#myFunc()
   */
  @Override
  protected void myFunc() { .. }
}
Run Code Online (Sandbox Code Playgroud)

java javadoc

13
推荐指数
1
解决办法
3万
查看次数

我如何在comments/JSDoc中引用另一个打字稿类型?

我对Javadoc很熟悉.在Javadoc中,您可以放置​​一个引用Javadoc的链接放在另一个类型上,如下所示:

/**
 * some java thingy. see this other java thingy too {@link OtherThingy}
 */
public class Thingy { /*...*/ }

/**
 * some other java thingy. see the first java thingy too {@link Thingy}
 */
public class OtherThingy{ /*...*/ }
Run Code Online (Sandbox Code Playgroud)

我可以在打字稿的JSDoc风格中做同样的事情吗?我知道我可以在评论中使用markdown,我可以放置网页链接,但这不是我想要的.

此外,任何对JSDoc/typescript文档工具的引用都会非常有用:)

编辑:根据下面的答案,这是JSDoc的一个功能,但似乎没有包含在VSCode中.VSCode中是否有有效的语法?

jsdoc typescript visual-studio-code

6
推荐指数
3
解决办法
2395
查看次数

标签 统计

java ×2

javadoc ×2

jsdoc ×1

typescript ×1

visual-studio-code ×1