用于在TypeScript接口上从JSDoc生成文档的工具
我有一个.d.ts文件,其中包含描述我的库的接口。它有JSDoc注释,当人们在代码中引用.d.ts时,将通过Visual Studio中的intellisense显示这些注释:用于在TypeScript接口上从JSDoc生成文档的工具,typescript,documentation-generation,jsdoc,Typescript,Documentation Generation,Jsdoc,我有一个.d.ts文件,其中包含描述我的库的接口。它有JSDoc注释,当人们在代码中引用.d.ts时,将通过Visual Studio中的intellisense显示这些注释: /** Description of JSNLogAppender */ interface JSNLogAppender { /* Description of setOptions */ setOptions(options: JSNLogAppenderOptions): void; /*
/** 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文档?目前没有。在此处也找不到任何相关的功能请求:
目前我们所拥有的只是理解JSDoc的TypeScript语言服务:我已经编写了这个小工具,它可能会有所帮助: 您需要安装Haskell平台来构建它
它对jsdoc样式的注释有基本的支持,并将在类型之间(可能跨模块)生成带有超链接的HTML。我发现一个npm模块声称可以这样做,尽管我还没有尝试过: 您可以使用 对于无法推断的内容,它支持jsdoc
而且它不识别的任何jsdoc描述符仍将被输出,这是幸运的。如果这些都是评论的真实例子,你可以不使用它们:)在没有任何工具的情况下,我正在考虑创建自己的。它将解析一个.d.ts文件(包括JSDoc),并使用T4模板生成HTML。我想知道这样一个工具是否对我以外的人有用,或者我是否偏离了正轨?我很想有一个工具来做这件事。一个建议是使用NodeJS而不是C#(我知道这可能会很痛苦),但它将更跨平台,并将集成到现代web工作流(例如gruntjs等)中。我看不到tsdoc声称从定义文件生成文档的任何地方。它只是说它使用TypeScript编译器从源代码生成文档。