繁体   English   中英

你如何在Javascript中为TypeScript编译器编写JSDoc?

[英]How do you write JSDoc in Javascript for TypeScript Compiler?

我知道有能力用TS编译器检查JS代码。 我知道TS编译器理解JSDoc注释( https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript )。

我想在我的React项目中使用TS编译器,我不知道如何用JSDoc指定道具定义:(

我试过了

class PropertyDetails extends React.Component {
  static propTypes = {
    breadcrumbChange: PropTypes.func,
    folderId: PropTypes.string.isRequired
  }

  /**
   * @typedef {Object} Props
   * @property {function} breadcrumbChange
   * @property {string} folderId
   */

  /**
   * @constructor
   * @param {Props} props
   */
  constructor(props) {
    super(props);

但它不起作用。

要使IntelliSense和类型检查工作,您必须为Component类指定prop类型,因为在typings中它被描述为泛型对象。 所以,如果你尝试这样的事情

/**
 * @typedef {Object} Props
 * @prop {Function} breadcrumbChange
 * @prop {string} folderId
 * @extends React.Component<Props>
 */
class PropertyDetails extends React.Component {
}

它应该工作

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM