【问题标题】：How to get jsdoc generation for parms of class methods that use arrow functions?如何为使用箭头函数的类方法的参数生成 jsdoc？
【发布时间】：2019-10-12 10:29:22
【问题描述】：

我是一名学生，其顶点项目/工作综合学习即将结束。我正在编写技术文档，以将其移交给将继续开展这项工作的下一个团队，但我遇到了障碍。

当我使用 jsdoc 工具创建文档时，我使用箭头函数的类方法不会生成 params 文档。

即：变成

文档在 Visual Studio 代码/智能感知中按预期工作：

我一直在谷歌搜索，试图找出问题所在，但我没有找到任何东西。

我的意思是，我的研究取得了成果：

使用箭头函数让 vscode 玩得更好的过时方法语法：(https://github.com/Microsoft/vscode/issues/36283) (https://github.com/Microsoft/vscode/issues/22264) ((这个是添加支持的实际问题)https://github.com/microsoft/TypeScript/issues/14134)
关于 jsdoc 对此功能的支持的过时信息： https://github.com/jsdoc/jsdoc/issues/1310
等等等等，再一次，没什么用处。

值得注意的是，我正在使用jsdoc-export-default-interop 插件，以便 jsdoc 实际上为export default [CLASS OR FUNCTION] 生成内容。

【问题讨论】：

这不是类方法，它是一个碰巧成为方法的属性。尝试将其定义为onPressItem(id) {...}。见"class method arrow"。
@laggingreflex，哦，是的。它是一个存储匿名函数/方法的属性。当我们将方法定义为类方法时遇到了问题，因为我们需要将该方法作为一等函数对象传递给其他反应组件。我不记得到底是什么问题，要么是崩溃，要么是立即调用该方法而不是组合。我正在为匿名函数生成 params 文档。

标签： javascript node.js visual-studio-code documentation jsdoc

【解决方案1】：

我找到了符合我要求的解决方案

但是，虽然它对我的目的来说已经足够了，但我并不完全确定它是否准确，并且很乐意听到批评、其他人的观点和解决方案。我会在最后解释我的担忧。

问题：jsdoc解析时好像不能自动检测成员赋值是否为函数。

我不知道为什么 VSCode 能够自动检测到它，但似乎 JSDoc 工具不能。这里在官方文档中有说明文档链接：(https://jsdoc.app/tags-function.html)

解决方案：使用`@function` 标签（或`@method` 之类的别名）记录成员。

通过使用@function 标签记录类成员，如下所示：

我能够将箭头函数生成为类方法，并获取 params 文档：

我的担忧

现在最大的担忧/烦恼是我需要浏览所有源代码并添加一堆@function 标签。啊小崽子。

其他担忧是我可能误解了问题/我不太确定这是否是最佳做法。

而且我不太确定这个文档是否准确，就类成员箭头函数和我需要在 API 文档中捕获的类方法之间是否确实存在明显差异而言。

无论如何，我认为这将是我的选择，但我会监控这个答案以阅读任何输入/反馈 :)

【讨论】：

我找到了符合我要求的解决方案

问题：jsdoc解析时好像不能自动检测成员赋值是否为函数。

解决方案：使用@function 标签（或@method 之类的别名）记录成员。

我的担忧

解决方案：使用`@function` 标签（或`@method` 之类的别名）记录成员。