创建Angular Storybook项目时启用Compodoc:是新增功能还是替代展示?
Compodoc在Angular Storybook中的作用
启用Compodoc不是单纯给Storybook换一种文档展示方式,而是补充和增强Storybook的文档能力,具体体现在这几点:
- 自动生成API级文档:Storybook默认的文档依赖你在stories文件里写的注释和示例,Compodoc会扫描Angular项目的源码(比如组件的
@Component元数据、类属性/方法注释、生命周期钩子等),自动生成更细致的API文档,涵盖组件输入输出、依赖、继承关系等Storybook原生没覆盖到的细节。 - 整合到Storybook界面:启用后,Storybook会新增一个
Docs标签页,把Compodoc生成的文档和你写的stories示例、自定义说明整合在一起,不用单独打开Compodoc的独立页面,在Storybook里就能一站式查看组件的所有信息。 - 补充可视化文档能力:Compodoc支持生成组件继承图、模块依赖图这类可视化内容,能帮团队快速理清项目结构,这是Storybook原生没有的额外功能。
- 与Storybook原生文档互补:它不是替代Storybook的现有文档体系,而是做补充——你依然可以写stories注释、MDX文档,同时获得自动生成的API文档支持,让组件文档更完整。
内容的提问来源于stack exchange,提问作者Ole
相关产品推荐
相关产品推荐

