在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

目前沒有。 在這里找不到任何相關的功能請求： http ： //typescript.codeplex.com/workitem/list/basic

我們目前所擁有的只是TypeScript語言服務理解JSDoc： http ： //typescript.codeplex.com/workitem/178

Answer 2

我寫過這個可能有用的小工具： typescript-docs

您需要安裝Haskell平台來構建它。

它對jsdoc樣式的注釋有基本支持，並將生成帶有類型之間超鏈接的HTML，可能跨模塊。

Answer 3

我找到了一個npm模塊聲稱要做到這一點，雖然我還沒有嘗試過： https ： //www.npmjs.org/package/tsdoc

Answer 4

你可以使用http://typedoc.org/

它支持jsdoc無法推斷的事情http://typedoc.org/guides/doccomments/

並且仍然會輸出它無法識別的任何jsdoc描述符，這是幸運的。