最新消息:雨落星辰是一个专注网站SEO优化、网站SEO诊断、搜索引擎研究、网络营销推广、网站策划运营及站长类的自媒体原创博客

如何为使用箭头函数的类方法的parms生成jsdoc?

运维笔记admin20浏览0评论

如何为使用箭头函数的类方法的parms生成jsdoc?

如何为使用箭头函数的类方法的parms生成jsdoc?

我是一名学生,他的基本项目/工作综合学习即将结束。我正在制作技术文档,以移交给下一个将继续进行此工作的团队,但我遇到了麻烦。

我使用jsdoc工具创建文档时,使用箭头函数的类方法未生成参数文档。

即:变成

该文档按Visual Studio代码/智能的预期方式运行:

我一直在搜寻以找出问题所在,但没有找到任何东西。

我的意思是,我的研究得出了:

  • 使用箭头功能使vscode发挥出色的过时方法语法:()()(((这是添加支持的实际问题))
  • 关于此功能的jsdoc支持的过时信息:
  • 等等,同样,没什么用。

[注意,我正在使用jsdoc-export-default-interop插件,以便jsdoc实际为export default [CLASS OR FUNCTION]生成东西。

回答如下:

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

但是,尽管对于我的目的而言已经足够好了,但我并不完全确定它是正确的,并且很乐意听到别人批评,别人的观点和解决方案。我将在最后解释我的担忧。

问题:解析时jsdoc似乎无法自动检测成员分配是否为函数。

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

解决方案:使用@function标记(或类似@method的别名)记录成员。

通过像这样用@function标记记录类成员:

我能够将arrow函数生成为类方法,并获取params文档:

我的担忧

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

其他担心是我可能误解了这个问题/我不确定这是否是最佳实践。

而且我不太确定该文档是否准确,因为类成员箭头函数与我需要在API文档中捕获的类方法之间是否确实存在明显差异。

无论如何,我认为这是我的目标,但是我将监视该答案以读取任何输入/反馈:)

发布评论

评论列表(0)

  1. 暂无评论