VSCode没有在对象中显示正确的参数

Question

我已经像这样对我的函数进行了 jsdoc：

/**
 * @typedef {Object} SearchTerms
 * @property {string} what
 * @property {string} where
 * @property {boolean} online
 */

/**
 * From react-router params, which are URL encoded, it figures out the "what", "where", and "online" terms.
 *
 * @export
 * @param {Object} params The `params` field from react-router component props.
 * @param {string} [params.what="Everything"] The subject of users search.
 * @param {string} [params.where] The location of users search.
 * @returns {SearchTerms}
 */
export function getSearchTerms(params)  {

但是params 键在函数悬停时没有正确展开：

无论如何它可以正确扩展params 参数吗？我希望它显示出来：

除了它还应该用问号表明它是可选的。当我输入参数时，它应该显示该参数的描述，如下所示：

Answer 1

问题是您已将params 参数的类型指定为Object。你应该将你的参数作为第二个@typedef：

/**
 * @typedef SearchOptions
 * @property {String} [what="Everything"] The thing
 * @property {String} [where] A place
 */

/**
 * @param {SearchOptions} params
 */
function getSearchTerms(params){ ... }

使用这样的命名接口，VSCode 应该像您正在寻找的那样在 Intellisense 中显示参数。