5

I have a .d.ts file with the interfaces describing my library. It has JSDoc comments, which will be shown via intellisense in Visual Studio when people refer to the .d.ts in their code:

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

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

... etc ...

I need to generate documentation based on the JSDoc and TypeScript interfaces. Problem is that the generators I found all work with JavaScript, and interfaces are not compiled to JavaScript. I could put the JSDoc on the actual classes and functions that implement the interfaces, but than I would lose the intellisense when people refer to the .d.ts file.

Is there a tool that generates html documentation from the JSDoc comments and the TypeScript interface definitions in a .d.ts file?

4

4 に答える 4

1

現時点ではありません。ここでも関連する機能要求が見つかりませんでした: http://typescript.codeplex.com/workitem/list/basic

現時点で私たちが持っているのは、JSDoc を理解する TypeScript 言語サービスです: http://typescript.codeplex.com/workitem/178

于 2013-05-20T00:13:06.570 に答える
1

まだ試していませんが、これを行うと主張する npm モジュールを見つけました: https://www.npmjs.org/package/tsdoc

于 2014-07-03T02:03:39.923 に答える
1

役に立つかもしれないこの小さなツールを書きました: typescript-docs

ビルドするには Haskell Platform をインストールする必要があります。

jsdoc スタイルのコメントの基本的なサポートがあり、タイプ間、場合によってはモジュール間でハイパーリンクを含む HTML を生成します。

于 2013-09-26T16:06:25.793 に答える