【问题标题】:Generate Typescript .d.ts file with original jsdoc comments?生成带有原始 jsdoc 注释的 Typescript .d.ts 文件?
【发布时间】:2015-10-04 06:44:48
【问题描述】:

上下文: 打字稿 1.5 测试版 网络风暴 10

我目前正在 TS 中开发两个独立的项目,一个库和一个将使用该库的项目。

当我在库项目中编码时,编写的jsdoc被Webstorm完全理解并且CTRL+Q正确显示。

然后我编译库(一个大的输出文件),生成 .d.ts 文件,并尝试在另一个项目中使用它:当我调用 CTRL+Q 时,没有更多可用的文档。

经过调查,我发现 JSDOC 仍然存在于生成的 javascript 中,但它不在 .d.ts 文件中 - 所以 Webstorm 认为没有。

所以我的问题是:如何在 .d.ts 生成时指定我希望我的 jsdoc 包含在其中?刚在网上转了几个小时……

--edit : 我的 tsconfig 文件--

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "noImplicitAny": false,
    "removeComments": false,
    "declaration":true,
    "noLib": false,
    "out": "./dist/myLib.es5.js",
    "sourceMap": true
  }
}

== 编辑最终版 ==

好的,文档终于出现在 .d.ts ... 编译器错误,或者可能是椅子键盘错误...

因此,当“removeComments”设置为 false 时,它​​显然应该可以工作!

【问题讨论】:

    标签: javascript compilation documentation typescript webstorm


    【解决方案1】:

    使用 cmets 编译,即将 removeComments 编译器标志设置为 false

    【讨论】:

    • 已经为假;我正在用这个细节更新原始问题。
    猜你喜欢
    • 2021-02-18
    • 1970-01-01
    • 2021-02-04
    • 2015-06-02
    • 2014-12-19
    • 1970-01-01
    • 2016-05-12
    • 2020-01-19
    相关资源
    最近更新 更多