如何在JSDOC（或Typescript？）中记录函数自定义类型并引用它们，以便VSCODE IntelliSense起作用

Question

我正在尝试将自定义函数类型作为对象的一部分进行记录，任何帮助都将不胜感激：

问题的上下文

是一个简单的对象声明，其中有某些函数属性（AddCoorcorion，AddCoordionAne，AddCoordinateTwo），我们将在3个展览中使用它，以及为什么这些都没有工作。

/**
 * @typedef {Object} Point
 * @property {number} x - The X Coordinate
 * @property {number} y - The Y Coordinate
 */

/**
 * @typedef {Object} Shape
 * @property {Point} startCoordinate - the starting coordinate
 * @property {Point[]} coordinates - An array of point coordinates
 * @property {(x:string, y:string) => void} addCoordinate - Updates the point
 * @property {addCoordinateOne} addCoordinateOne - Updates the point
 * @property {addCoordinateTwo} addCoordinateTwo - Updates the point
 */

/** @type {Shape} */
const square = {}

展示A

@property {(x:string, y:string) => void} addCoordinate - Updates the point

This作品的全部作品，但不能像我需要的那样重复使用。

展览b

/**
 * @typedef {Function} addCoordinateOne
 * @param {string} X
 * @param {string} Y
 */

这是一种的作品，因为它检测到自定义函数类型。但是它不能正确解析参数。我确保遵循@TyPedef标签的文档： https://jsdoc.app.app/tags-tags-typedef.html

/I.SSTATIC.NET/4LBHS.png“ rel =“ noreferrer”>

”

/**
 * @function addCoordinateTwo
 * @param {string} X
 * @param {string} Y
 */

https://i.sstatic.net/4lbhs.png 完全失败。尽管是JSDOC的@function文档推荐的方法。

https://jsdoc.app/tags-function.html

获得展览B或C像展览A一样工作？

Answer 1

您可以将展览a更改为typedef：

/** @typedef {(x:string, y:string) => void} addCoordinate */

编辑：或逐字化，可以使用 @callback标签：

/** 
 * @callback addCoordinate
 * @param {number} x - The x coordinate
 * @param {number} y - The y coordinate 
 * @returns {void}
 */

然后根据需要重复使用：

/**
 * @typedef {Object} Point
 * @property {number} x - The X Coordinate
 * @property {number} y - The Y Coordinate
 */

/**
 * @typedef {Object} Shape
 * @property {Point} startCoordinate - the starting coordinate
 * @property {Point[]} coordinates - An array of point coordinates
 * @property {addCoordinate} addCoordinate - Updates the point
 * @property {addCoordinate} addCoordinateOne - Updates the point
 * @property {addCoordinate} addCoordinateTwo - Updates the point
 */

结果：

如果使用速记语法，则没有paramater说明可用。

如果使用@Callback语法，则为每个Paramater提供了描述：