Как материал angular автоматически генерирует документацию по API?

Question

Я заметил, что Angular Материал (https://github.com/angular/components) генерирует части своих документов из комментариев кода, например, здесь: https://material.angular.io/components/tabs/api. Как они это делают? И остальная часть документации просто закодирована или построена динамически «волшебным» образом?

Cheers Tobi

Answer 1

Есть инструменты, которые могут помочь с такими задачами. Вы можете использовать compodo c,

Compodo c - инструмент документирования для Angular приложений. Он генерирует stati c документацию вашего приложения.

Вам необходимо описать функцию следующим образом:

/ **

• @ param {string} target Цель для обработки
• @ возвращает обработанный номер цели

* /

function processTarget (target: string): number {};