生成带有原始 jsdoc 注释的 Typescript .d.ts 文件?
Generate Typescript .d.ts file with original jsdoc comments?
上下文:
打字稿 1.5 测试版
网络风暴 10
我目前正在 TS 中开发两个独立的项目,一个库和一个将使用该库的项目。
当我在库项目中编码时,Webstorm 完全理解编写的 jsdoc 并且 CTRL+Q 正确显示它。
然后我编译库(一个大的输出文件),一路生成 .d.ts 文件,并尝试在另一个项目中使用它:调用时没有更多文档可用CTRL+Q.
经过调查,我发现 JSDOC 仍然存在于生成的 javascript 中,但它不在 .d.ts 文件中 - 所以 Webstorm 认为存在 none。
所以我的问题是:如何在 .d.ts 生成时指定我希望将我的 jsdoc 包含在其中?刚刚在网上花了几个小时 运行 兜圈子...
--编辑:我的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 时它显然应该有效!
使用注释进行编译,即将 removeComments
编译器标志设置为 false
上下文: 打字稿 1.5 测试版 网络风暴 10
我目前正在 TS 中开发两个独立的项目,一个库和一个将使用该库的项目。
当我在库项目中编码时,Webstorm 完全理解编写的 jsdoc 并且 CTRL+Q 正确显示它。
然后我编译库(一个大的输出文件),一路生成 .d.ts 文件,并尝试在另一个项目中使用它:调用时没有更多文档可用CTRL+Q.
经过调查,我发现 JSDOC 仍然存在于生成的 javascript 中,但它不在 .d.ts 文件中 - 所以 Webstorm 认为存在 none。
所以我的问题是:如何在 .d.ts 生成时指定我希望将我的 jsdoc 包含在其中?刚刚在网上花了几个小时 运行 兜圈子...
--编辑:我的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 时它显然应该有效!
使用注释进行编译,即将 removeComments
编译器标志设置为 false