網站搜尋

從 TypeScript 介面的 JSDoc 生成文件的工具


我有一個 .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 文件時,我就會失去智能提示。

有沒有一種工具可以從 JSDoc 註解和 .d.ts 文件中的 TypeScript 介面定義生成 HTML 文件?

答案#1

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

它支援 jsdoc,用於它無法推斷的內容 http://typedoc.org/guides/doccomments/

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

答案#2

我找到了一個聲稱可以做到這個的 npm 模組,雖然我還沒試過:https://www.npmjs.org/package/tsdoc