我在测试autodocs(运行良好),但想要添加更多细节。我模糊地记得我可以在某个地方写一些注解,但在7.0文档中没有看到任何关于它的内容。我最终查看了一些示例组件和故事,并弄清楚了我需要什么。我希望在文档中看到三个新增的内容,这样其他人就不会遇到这个问题了:
dly7yett1#
看起来现在是实时的。
https://storybook.js.org/docs/react/api/doc-block-description#writing-descriptions
然而,当通过组件上方的JSDoc注解编写描述时,autodocs中没有渲染描述。
ohfgkhjo2#
@MichaelArestad - 上面的文档是否足够?还是你觉得这也需要放在某个指南里?
np8igboo3#
我不确定是否能在文档块部分找到它。但我肯定会在" Writing docs "指南中找到它。
u0njafvf4#
这仍然似乎缺失。然而,当通过上述组件上方的JSDoc注解编写描述时,autodocs中没有呈现任何描述。我不认为这些内容已经涵盖。如果它们确实被涵盖了,那么我在文档中找不到它们。
4条答案
按热度按时间dly7yett1#
看起来现在是实时的。
https://storybook.js.org/docs/react/api/doc-block-description#writing-descriptions
然而,当通过组件上方的JSDoc注解编写描述时,autodocs中没有渲染描述。
ohfgkhjo2#
@MichaelArestad - 上面的文档是否足够?还是你觉得这也需要放在某个指南里?
np8igboo3#
我不确定是否能在文档块部分找到它。但我肯定会在" Writing docs "指南中找到它。
u0njafvf4#
这仍然似乎缺失。
然而,当通过上述组件上方的JSDoc注解编写描述时,autodocs中没有呈现任何描述。我不认为这些内容已经涵盖。如果它们确实被涵盖了,那么我在文档中找不到它们。