StencilJS：禁用自动生成某些组件的自述文件

Question

StencilJS 自动生成很棒：https://stenciljs.com/docs/docs-readme 有什么方法可以为某些组件禁用它吗？

希望有一些简单的东西，比如在 tsx 文件的顶部添加一行？

Answer 1

如果存在此功能，我怀疑它可能基于 JSDoc 注释，可能 @ignore.

我只是通过添加这些注释来测试它，自从自述文件构建以来它们似乎被忽略了。

我建议在 the ionic-team/stencil repository 中打开一个功能请求问题。一个重要的细节是这些组件是否也应该从其他（未忽略的）组件的 Dependencies 部分隐藏。

您也可以尝试自己实现，我认为过滤组件 here 应该可以。

---

更新

通过将 @internal 添加到 JSDoc，有一个未记录的功能可以实现此目的。

我刚刚成功测试了它的组件以及 Stencil 1.12.5 中的特定属性，但从查看 git 历史来看，它似乎已经可用了一段时间（几年最少）。

示例：

忽略组件：

/** @internal **/
@Component({...})
export class MyComponent {...}

单身属性

@Component({...})
export class MyComponent {
  @Prop() visibleProp = '';

  /** @internal **/
  @Prop() hiddenProp = '';
}