VS Code 中的 JSDoc typedef 方法答案

【问题标题】：JSDoc typedef methods in VS CodeVS Code 中的 JSDoc typedef 方法
【发布时间】：2020-12-19 08:37:10
【问题描述】：

我在尝试记录 javascript 方法时遇到问题，

我试过这个：

我真的不认为我应该为 getMother() 设置一个属性，而是一个方法。

但我什至不知道它是否受支持（我正在使用 VS Code）。

所以给定的示例可能有效，但它在自动完成时没有添加括号，而且不干净，因为我们将其视为属性。

我花了几个小时寻找解决方案，但失败了。我希望有人知道答案，请随时询问更多详细信息。

【问题讨论】：

标签： javascript visual-studio-code jsdoc

【解决方案1】：

你可以试试这样的：

// @ts-check

/*
 * @typedef {{
 * age: number,
 * getMother(arg1: string, arg2: string): HTMLCat
 * } & HTMLElement} HTMLCat
 */

/*
 * @type {HTMLCat}
 */
var cat;

cat.getMother('a', 'b').age

我不确定AdditionalCat 到底在做什么，因为它只是一个对象，可能与我添加的key/value 索引相关，所以我把它省略了。但是这种语法可能更容易推理。

【讨论】：

很好的答案！我想知道为什么很难找到一个好的示例/教程。我希望也许其他人会发现它有用。
我发现添加可选参数就像“名称？”一样简单。我很困惑，因为我不知道有两种表示法。