Værktøj til at generere dokumentation fra JSDoc på TypeScript-interface

Jeg har en .d.ts-fil med de interfaces, der beskriver mit bibliotek. Den har JSDoc-kommentarer, som vil blive vist via Intellisense i Visual Studio, når folk henviser til .d.ts i deres kode:

/** Description of JSNLogAppender */
interface JSNLogAppender {
    /* Description of setOptions */
    setOptions(options: JSNLogAppenderOptions): void;

    /* Description of log */
    log(logItem: JSNLogItem): void;
}

... etc ...

Jeg har brug for at generere dokumentation baseret på JSDoc og TypeScript-interface. Problemet er, at de generatorer, jeg har fundet, alle arbejder med JavaScript, og interfaces bliver ikke kompileret til JavaScript. Jeg kunne sætte JSDoc på de faktiske klasser og funktioner, der implementerer interfacene, men så ville jeg miste intellisense, når folk henviser til .d.ts-filen.

Findes der et værktøj, der genererer HTML-dokumentation fra JSDoc-kommentarer og TypeScript-interface-definitioner i en .d.ts-fil?

Svar #1

Du kan bruge http://typedoc.org/

Den understøtter jsdoc for ting, det ikke kan udlede http://typedoc.org/guides/doccomments/

Og enhver jsdoc-beskrivelse, som det ikke genkender, vil stadig blive vist, hvilket er heldigt.

Svar #2

Jeg har fundet en npm-modul, der hævder at kunne gøre dette, selvom jeg ikke har prøvet det endnu: https://www.npmjs.org/package/tsdoc

Relaterede artikler