在TypeScript接口上从JSDoc生成文档的工具

Question

我有一个.d.ts文件,其中包含描述我的库的接口.它有JSDoc注释,当人们在代码中引用.d.ts时,它将通过Visual Studio中的intellisense显示:

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

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

... etc ...

我需要基于JSDoc和TypeScript接口生成文档.问题是我发现的所有生成器都使用JavaScript,并且接口不会编译为JavaScript.我可以将JSDoc放在实现接口的实际类和函数上,但是当人们引用.d.ts文件时,我会丢失智能感知.

是否有一个工具可以从.d.ts文件中的JSDoc注释和TypeScript接口定义生成html文档？

Answer 1

我发现一个 npm 模块声称可以做到这一点，尽管我还没有尝试过： https: //www.npmjs.org/package/tsdoc