Angular HTML 中的 2+ 个组件文档预览

Question

我想知道是否可以为 angular 组件编写文档，以便在 HTML 中添加新组件时显示为工具提示。我正在使用 Webstorm。

我的意思是：

如果我有组件 A


/**
 * This is the documentation intended to be shown in the tooltip.
 */
@Component({
  selector: 'app-a',
  templateUrl: './a.html',
  styleUrls: ['./a.scss']
})
export class AComponent {
  constructor() { }
}

在组件BHTML中

  <app-a></app-a>

我希望通过悬停或使用 IDE 的显示文档快捷方式来查看组件的文档。

（我的结果）

（预期结果）

Answer 1

IDE中没有这样的功能；我们计划将其添加到最近的 IDE 更新之一，可以在 WEB-43480

跟踪进度

Angular HTML 中的 2+ 个组件文档预览

Angular 2+ component documentation preview in HTML

documentation

webstorm

angular