jsdoc - 在 JsDoc 3 中，注释返回对象的正确方法是什么？

Question

我在我的 React 项目中使用 JSDoc 3.6.4。我已经定义了以下钩子......

import { useState } from "react";

/**
 * The form hook.  Sets handlers and initial properties of a form. 
 *
 * @param {Object.<string, string>} initialValue
 * @returns {object}
 */
const useForm = (initialValue = {}) => {
  const [values, setValues] = useState(initialValue);

  const reset = () => {
    setValues(initialValue);
  };

  const handleChange = ({ target }) => {
    setValues((values) => ({
      ...values,
      [target.name]: target.value,
    }));
  };

  return {
    handleChange,
    values,
    reset,
    setValues,
  };
};

export default useForm;

当返回多个东西时，记录返回内容的正确方法是什么？我想放的不仅仅是 {object}，这就是我现在所拥有的。

标签： jsdoc

Answer 1

您可以使用@typedef注释。

正如您在截屏视频中看到的：

• VS Code 可以判断bar返回Foo
• 当鼠标悬停时@return {Foo}，VS Code 可以显示它的形状