如何在JSDoc中标记并展示函数内部调用的其他函数？

实现方法 #

这个需求完全可以实现，常用的实现方式有两种，都可以满足你展示内部调用列表、支持跳转的要求：

• 方式一：直接在JSDoc注释中新增专门的说明段，用列表展示所有内部调用的函数，配合{@link}标签实现跳转。这种方式不需要额外配置，所有支持JSDoc的工具都能正常识别。
• 方式二：使用JSDoc原生的@uses标签标记调用的依赖函数，主流文档生成工具（如JSDoc、TypeDoc）会自动将这类标签整理为独立的调用/依赖列表展示，同样支持@link跳转。@uses是JSDoc官方定义的标准标签，语义就是标记当前代码依赖使用的其他单元，用来标记内部调用的函数非常契合，不需要额外配置就能被大部分文档工具识别。

如果你的文档工具支持自定义标签，你也可以自行定义@calls之类的专属标签用于标记内部调用，只需要在JSDoc配置文件中补充对应标签的解析规则即可，展示效果和@uses完全一致。

修改后的代码示例 #

/**
 * 该函数会在{@link myFunc1}内部被调用
 */
const myFunc2 = function() {
   console.log('I got called!')
}

/**
 * 该函数内部会调用{@link myFunc2}
 * 
 * **内部调用函数列表：**
 * - {@link myFunc2}
 * 
 * @uses myFunc2
 */
function myFunc1() {
   myFunc2()
}

内容的提问来源于stack exchange，提问作者Gia Phu Tang