Я документирую методы внутри компонента React, используя JSDoc3.Поскольку я использую компоненты React, все значения, «переданные» в метод, проходят через подпорки, а значение «возвращено» действительно является установленным атрибутом.
Каковы правильные теги для документирования этого?
/**
* updateRows
*
* @this Row
* @property {string[]} data - array of strings to be made into rows of text elements.
* @returns {JSX[]} JSX element array of rows to be rendered.
*/
updateRows() {
const {data} = this.props;
let arr = data.map((d, i) => {
return(
<text key={i}>
{d}
</text>
);
});
this.rows = arr;
}
Я хочу четко показать, что метод требует, чтобы реквизит «данных» имел вход, и что он создает выходной массив, к которому можно получить доступ, но в настоящее время он выглядит так, как будто он возвращает указанный массив, чего нет.