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} path - absolute file path
 * @param {(error: string, namedParameter: type)} callback - callback called when done
*/
function loadFile(path, callback) {
  /// code
}

Answer 2

此模式有效：

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

void这里代表没有返回值，可以用回调返回值替换（例如：{function(value):boolean}作为谓词）。

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

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

2 个答案: