JSDoc / TSDoc中是否有一种方法可以链接到代码段?

时间:2018-09-15 10:49:18

标签: javascript typescript jsdoc

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

因此,想象一下,每个测试用例与其实现的链接都可以使工作变得更轻松。有什么办法(如果JSDoc / TSdoc没有它,也许有一些IDE扩展,库或约定)?

还有一些期望的行为:

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

1 个答案:

答案 0 :(得分:1)

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

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

注意:通常只有在您为相关代码编写了文档的情况下才能使用。

关于在测试中进行此操作,可能取决于您使用的测试工具。 关于开玩笑(我也认为摩卡咖啡也是如此),您可以看到JSDoc doclet的一部分(发生故障)。请注意,它不会向您显示基础函数/方法的doclet。