【问题标题】:Is there a way in JSDoc/TSDoc to make links to code pieces?JSDoc/TSDoc 中有没有办法链接到代码片段?
【发布时间】:2019-05-08 18:05:34
【问题描述】:

问题:当您处理一个或多个大型项目时,其中一个测试由于某种原因失败了,您可以看到哪个功能失败了,但很难回忆起实施的位置。

所以想象一下,每个测试用例中与其实现的链接可以让生活更轻松。有什么办法(如果 JSDoc/TSdoc 没有,也许有一些 IDE 扩展或库或约定)?

还有一些期望的行为:

  • 到该行的链接是不切实际的,因为您知道,代码更改和行的内容也是如此。所以两端应该有一些锚点,就像在 HTML 中一样。
  • 指向类甚至方法的链接并不总是可以指向确切的实现。
  • 链接在 IDE 中当然应该是可点击的,否则它的有用性几乎为零

【问题讨论】:

    标签: javascript typescript jsdoc


    【解决方案1】:

    我知道这个问题是在 234 天前发布的,但以下答案可能会帮助到这里的一些人。

    如果我正确理解了您的问题,您正在寻找的是大多数 IDE 和编辑器所做的(至少 JetBrains IDE、Sublime Text 和 VSCode 可以做的),换句话说:有可能导航到实现函数/方法/类/...(通常可以通过右键单击它然后选择相关选项来实现)。
    因此,在 VSCode 上,您需要在右键单击相关函数/方法调用后点击 “转到定义”(或按 F12) /em>。 在 JetBrains IDE 上,如果我没记错的话,上下文菜单选项称为 “Go to Implementation”

    注意:这通常仅在您为相关代码编写文档时才有效。

    至于在测试中使用此功能,可能取决于您使用的测试工具。 关于 jest(我也认为 mocha),您可以看到(部分)发生故障的 JSDoc doclet;请记住,它不会向您显示底层函数/方法的 doclet。

    【讨论】:

    • 也许你可以为一个 IDE 写一个更详细的描述?
    • @JJJ 好点,我已经为一些 VSCode 和 JB IDE 添加了更多细节。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2016-11-21
    • 2022-06-30
    • 1970-01-01
    • 2011-06-02
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多