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,
});

在此上下文中，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了解详情。

Answer 2

这意味着

{*}无论你想要什么

In the documantation you can see这里是回复returns

的文档

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

2 个答案: