javascript - JSDoc - 从函数返回 * 是什么意思？

Question

使用WebStorm ，以下JSDoc文档已生成:

/**
 * Patient retrieval success action
 * @param {Object} patient - Patient object returned from getPatient search query
 * @returns {{type, patient: *}}
 */
export const getPatientSuccess = patient => ({
  type: PATIENT_LOADED,
  patient,
});

在此上下文中，患者是一个可能包含变量信息的对象。这是另一个带有类似 JSDoc 生成评论的部分:

/**
 * Functional stateless component to display medication data
 * @param medications
 * @returns {*}
 * @constructor
 */
const Medications = ({ medications }) => {
  if (medications.status === 'success') {
    // Return table of medications if available
    return (/** Table of medications */);
  }

  // Return NoDataView by default if no meds are available
  return (
    <NoDataView
      heading="Data Unavailable"
      subtext="Medications data unavailable"
      isGlyphHidden={false}
    />
  );
};

在此上下文中，可以返回可变组件信息。这就是 @returns {*} 的意思吗？

Answer 1

在 JSDocs 中，@returns 和 @param 属性的类型信息通常包含在大括号中。

@return {*} 指定函数返回类型 *。

* 是代表任何类型的通配符。

换句话说，该函数可以返回任何类型。

<小时/>

查看 JSDocs docs了解更多信息。