Моя цель - иметь описательную документацию, связанную с экспортом по умолчанию компонента, заключенного в компонент более высокого порядка.
Например, я ищу способ иметь такой компонент, как этот:
import React, { FC } from "react";
import { connect } from "react-redux";
/**
* Base component Example
*
* @param display The word displayed in my component.
*/
const Example = ({ display }) => {
return <div>{display}</div>;
};
const mapStateToProps = (state) => ({ todos: state.todos });
export default connect(mapStateToProps)(Example);
И все еще есть документация по нему при импорте в другое место, так как в настоящее время в документации будет просто отображаться
Пример импорта
в отличие от надлежащая документация, которая должна отображать
Пример базового компонента @ param display - Слово, отображаемое в моем компоненте.
Сейчас , Я обнаружил, что могу воспроизвести это, назначив возврат от компонента более высокого порядка переменной и поместив над ним описательную документацию следующим образом:
import React, { FC } from "react";
import { connect } from "react-redux";
/**
* Base component Example
*
* @param display The word displayed in my component.
*/
const Example = ({ display }) => {
return <div>{display}</div>;
};
const mapStateToProps = (state) => ({ todos: state.todos });
/**
* Base component Example
*
* @param display The word displayed in my component.
*/
const ret = connect(mapStateToProps)(Example);
export default ret;
Но проблема с этим решением в том, что Мне либо нужна дублирующая документация, либо документация находится под фактическим определением компонента.
*
Моя цель - воспроизвести отображение с второй пример кода, сохраняя при этом четкость, отсутствие дублирующей документации и имея документацию над кодом, который он описывает из первого примера кода. Я не возражаю, если это связано с добавлением нескольких строк кода между компонентом и его документацией, если документация может оставаться над компонентом в файле, и в идеале я ищу решение, которое как можно ближе к текущая структура кода, но все работает, пока работает.
Большое спасибо за ваше время.