使用 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 {*}
的意思吗?
在 JSDocs 中,类型信息通常用大括号括起来,用于@returns
和@param
属性。
@return {*}
指定函数返回类型 *
。
*
是代表任何类型的通配符。
换句话说,该函数可以返回任何类型。
查看 JSDocs 文档以获取更多信息。
这意味着
{*} 随心所欲
在文档中,您可以看到,这是返回返回的文档