logo标签列表

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

typescriptdocumentation-generationjsdoc
7

我有一个.d.ts文件，其中包含描述我的库的接口。它带有JSDoc注释，当人们在他们的代码中引用.d.ts时，在Visual Studio中通过智能感知将显示这些注释：

/** 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文件时就会失去智能提示。
有没有工具可以从JSDoc注释和.d.ts文件中的TypeScript接口定义生成HTML文档？
3
如果这些是真实的评论例子，你可以不必理会它们 :) - Fenton
4个回答
4
1
在没有任何工具可以做到这一点的情况下，我正在考虑创建自己的工具。它将解析 .d.ts 文件（包括 JSDoc）并使用 T4 模板生成 HTML。我想知道除了我自己之外，这样的工具是否对其他人有用，或者我是不是走错了方向？ - user1147862
2
我很想要一个工具来完成这个任务。一个建议是使用NodeJS而不是C#（我知道它可能会很麻烦），但这样做可以更跨平台，并且可以与现代Web工作流程（例如http://yeoman.io/ gruntjs等）集成。 - basarat
1
1
我没有看到 tsdoc 在哪里声明从定义文件生成文档的功能。它只是说使用 TypeScript 编译器从源代码生成文档。 - Adam Harte
1
我编写了一个小工具，可能会有所帮助：typescript-docs。
您需要安装Haskell平台来构建它。
它具有基本的jsdoc风格注释支持，并将生成带有类型之间超链接的HTML，可能跨越模块。
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接