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

Question

I am wondering if it is possible to write documentation for angular components that will be displayed as a tooltip when adding a new component in HTML. I am using Webstorm.

I mean:

If I have component 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() { }
}

In the HTML of the component B

  <app-a></app-a>

I expect to see the doc of the component by hovering or using the show documentation shortcut of my IDE.

(my result)

(result expected)

Answer 1

There is no such feature in the IDE; we plan to add it in one of the nearest IDE updates, the progress can be tracked at WEB-43480