我需要为我们在reactjs应用程序中定义的每个组件创建doc文件。我正在寻找npm,我们可以用它来创建任何扩展的文档,这样它就可以提取代码,注释我的组件中的一切,并将其更改为任何扩展的文档。我该怎么做,请帮帮我?我的问题与其他关于jsdoc的问题不同,因为我正在使用jsdoc在reactjs中查找文档。
发布于 2017-01-27 21:51:31
试试这个包,里面有一些你可以理解的例子。
它为通过React.createClass、ES2015类定义或函数(无状态组件)定义的React组件提供了默认实现。这些组件定义必须遵循特定的指导原则才能进行分析(有关更多信息,请参见下文)。
发布于 2019-09-04 15:04:23
JSDoc有一个名为better-docs的主题,它有一个@component插件。当您将其添加到您的组件中时(作为任何其他标记),它将解析您的所有propTypes并生成文档。此外,当您将其与@example tag -better一起使用时,docs将打印实时预览。
发布于 2017-04-06 01:21:39
我们有很多react组件库,并使用react-showroom
它允许在markdown中编写文档,并具有沙箱。这样做的一个很大的好处--你可以在两分钟内开始一个新的项目,并且已经配置好了webpack,巴别塔,林特等。
非常推荐尝试一下。
https://stackoverflow.com/questions/41847565
复制相似问题