如何在 JSDoc 中为 Visual Studio intellisense 记录回调参数？

Question

我只是不知道如何使用 @param 正确记录回调，以便 Visual Studio 2017 intellisense 能够理解它。

例如：

/**
 * @param {string} file absolute path
 * @param {Function} callback called when done
*/
function loadFile(path, callback) {
    /// code
}

回调接受 Error 和 string 作为参数（Node.js 样式），如何记录它？

Answer 1

此模式有效：

/**
 * @param {string} file absolute path
 * @param {function(Error, string):void} callback called when done
*/
function loadFile(path, callback) {
    /// code
}

这里的

void代表没有return值，可以用回调return值代替（例如：{function(value):boolean}表示predicate）。

我不知道如何记录参数名称。

Answer 2

要使用类型和名称注释回调参数，请执行以下操作：

/**
 * @param {string} path - absolute file path
 * @param {(error: string, namedParameter: type)} callback - callback called when done
*/
function loadFile(path, callback) {
  /// code
}

如何在 JSDoc 中为 Visual Studio intellisense 记录回调参数？

How to document callback parameters in JSDoc for Visual Studio intellisense?

javascript

jsdoc

visual-studio-2017