@ types / node和VS Code:由于评论格式

时间:2017-03-21 09:22:32

标签: node.js typescript visual-studio-code typescript-typings

我使用Visual Studio Code和@ types / node(7.0.8),但似乎某些函数等具有错误的格式化代码注释,因此Visual Studio Code和Visual Studio 2017将不会在IntelliSense中显示任何quickinfos。

例如

import * as fs from 'fs';
fs.unlink

当我键入fs.unlink VS Code时,显示函数签名,但不显示

中定义的注释whitch
./node_modules/@types/node/index.d.ts

第2400行

/*
 * Asynchronous unlink - deletes the file specified in {path}
 *
 * @param path
 * @param callback No arguments other than a possible exception are given to the completion callback.
 */
 export function unlink(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void;

这里的罪魁祸首是错过星号的第一行。 正确的表示法是

/**

一旦我更改了index.d.ts,我就会开始使用IntelliSense。 有些功能是正确评论而其他功能则没有。

我在这里做错了吗? (尽管被导出但不是要使用的那些功能) 在@ types / node中是错误的吗?如果有的话有教导VS Code来解析这些注释的方法吗?

由于

1 个答案:

答案 0 :(得分:2)

我致力于对VSCode的TS和JS支持。使用/*代替/**看起来像是节点d.ts类型定义中的错误。据我所知,没有办法配置TypeScript或VSCode将普通的旧/*注释视为文档注释。

我已经提交了一个包含修复程序的公关:https://github.com/DefinitelyTyped/DefinitelyTyped/pull/15285