api-extractor:帮助从React组件提取api的工具

时间:2024-06-03 02:51:54
【文件属性】:

文件名称:api-extractor:帮助从React组件提取api的工具

文件大小:114KB

文件格式:ZIP

更新时间:2024-06-03 02:51:54

JavaScript

@alifd/api-extractor 一个从 React 组件代码中提取 API 信息的工具,一般用来生成 API 文档,开发编辑器组件 API 提示插件以及开发页面搭建平台组件物料的属性面板,代码中附加信息书写方式来源于,整体底层解析工具依赖于 和 。 Feature 支持通过propTypes获得属性类型 支持通过defaultProps获得属性默认值 支持通过propTypes上的 jsDoc 注释获得属性描述,自定义属性默认值 支持通过书写 jsDoc 获取函数类型属性的参数和返回值 支持通过书写 jsDoc 获取对象类型属性的属性 支持通过书写 jsDoc 获取组件静态方法和实例方法的描述,参数以及返回值 支持根据提取的 API 信息生成 markdown 片段,方便灵活组织API文档 支持通过按照约定书写组件上的 jsDoc 来获得父组件与子组件关系 支持通过propTy


【文件预览】:
api-extractor-master
----.eslintrc.json(438B)
----lib()
--------parseJsDoc.js(3KB)
--------index.js(11KB)
----example()
--------my-component.jsx(2KB)
--------script.js(318B)
--------api.json(5KB)
--------markdown.png(106KB)
----LICENSE(1KB)
----test()
--------input.jsx(1KB)
--------base.jsx(3KB)
--------computed.jsx(174B)
--------hint.jsx(1KB)
--------tests.js(953B)
----README.md(8KB)
----.editorconfig(374B)
----.gitignore(55B)
----package.json(1KB)

网友评论