如何使用JSDocs注释ReactJS状态完整的“类”组件道具

时间:2020-05-30 16:39:46

标签: javascript reactjs jsdoc

如何在状态为“类”的ReactJS组件中注释道具,以便在render()中获得自动完成功能? 我尝试了以下操作,但没有成功:

  export default class MyComponent extends Component {

  /**
   * @param {object} props
   * @param {object} props.survey
   * @param {string} props.survey.name
   */
  constructor(props){
    super(props)
    // autocompletion works here
 }

  render() {
    // autocompletion does not work here

    return (
     console.log(this.props.survey.name)
    );
  }
}

1 个答案:

答案 0 :(得分:0)

  /**
   * @typedef {object} props
   * @property {object} survey
   * @property {string} survey.name
   * @extends {Component<props>}
   */
  export default class MyComponent extends Component {

  constructor(props){
    super(props)
    // autocompletion works here
 }

  render() {
    // autocompletion should work here
    const {survey} = this.props;
    return (
     console.log(survey.name)
    );
  }
}