VS Code 中的 JSDoc typedef 方法

Question

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

我试过这个：

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

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

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

我花了几个小时寻找解决方案但失败了。希望有人知道答案，欢迎追问。

Answer 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 索引相关，所以我将其省略。但是这种语法可能更容易推理。

您可以在此处找到更多示例：https://medium.com/better-programming/type-checking-in-vscode-without-typescript-eba92161cd08

VS Code 中的 JSDoc typedef 方法

JSDoc typedef methods in VS Code

javascript

jsdoc

visual-studio-code