我想使用 jsdoc 在我的代码中添加解释

Question

我正在使用 jsDoc 来解释 onChange 函数所以我的任务是如果有人想使用我在我的 repo 中添加的组件我想告诉用户 onChange 就像它接受的参数一样所以我很困惑如果我添加一些解释，以便其他人能够理解或不理解

This is my component

/**
 * @type {string}
 * @param {*} onChange - onChange will accept parameter as (value: any) => void.
 * @returns 
 */

我需要解释的这个 onchange 函数意味着如果有人使用我的组件用户需要像这样传递参数我的组件 onChnage 接受这样的输入

  const handleDateChange = (date) => {
    setSelectedDate(date);
  };
<DatePicker
          disableToolbar
          variant="inline"
          format="MM/dd/yyyy"
          margin="normal"
          id="date-picker-inline"
          label="Date picker inline"
          value={selectedDate}
          onChange={handleDateChange}
          KeyboardButtonProps={{
            'aria-label': 'change date',
          }}
        />

Answer 1

如果我理解正确，您想要记录以下用于 React 组件的 onChange 处理程序的函数签名：

const handleDateChange = (date) => {
  setSelectedDate(date);
};

它似乎是一个使用 date 参数的函数，我假设该参数是用于此答案的字符串。以下是我将如何记录函数签名。

@param {(date: string) => void} onChange - date change handler.

更新

啊，我刚刚意识到你想要记录 React 组件的道具。先定义props对象，再定义props.onChange.

/**
 * DatePicker component
 * @param {Object} props - component props
 * @param {(date: string) => void} props.onChange - date change handler.
 * @returns JSX.Element
 */
export default function DatePicker({
   ...props
}) {
  ...
  return (
    <MuiPickersUtilsProvider utils={DateFnsUtils}>
      <KeyboardDatePicker {...props} />
    </MuiPickersUtilsProvider>
  );
}

我想使用 jsdoc 在我的代码中添加解释

i want to add explanation in my code using jsdoc

javascript

jsdoc

reactjs

更新