You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何配置compodoc以忽略所有私有成员?

如何通过Compodoc配置忽略所有私有成员

完全可以通过Compodoc的配置全局忽略所有私有成员,无需逐个添加@ignore标记来冗余组件的JSDoc。具体操作如下:

  • 在Compodoc配置文件(通常为compodoc.json)中添加privateApi配置项,将其值设为false:
{
  "privateApi": false,
  // 保留你原有的其他配置内容
}
  • 若通过CLI命令启动Compodoc,可直接追加参数实现:
compodoc -p tsconfig.json --private-api false

该配置会让Compodoc自动排除所有以private修饰的类成员(包括属性、方法),生成的documentation.json将不再包含这些私有内容,Storybook UI也会恢复整洁。

内容的提问来源于stack exchange,提问作者Nate May

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.28 17:44:53