@types/node и VS Code: IntelliSense не работает из-за форматирования комментариев

Я использую Visual Studio Code и @types/node (7.0.8), но кажется, что некоторые функции и т. д. имеют неправильный отформатированный комментарий к коду, и поэтому Visual Studio Code и Visual Studio 2017 не будут отображать какие-либо краткие сведения в IntelliSense.

пример

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

Когда я набираю fs.unlink VS Code, отображается подпись функции, но не комментарий, который определен в

./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 анализировать эти комментарии?

Спасибо


person Arikael    schedule 21.03.2017    source источник


Ответы (1)


Я работаю над поддержкой TS и JS для VSCode. Использование /* вместо /** выглядит как ошибка в определении типа узла d.ts. Насколько мне известно, нет способа настроить TypeScript или VSCode для обработки простых старых комментариев /* как комментариев к документации.

Я отправил PR с исправлением: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/15285

person Matt Bierner    schedule 21.03.2017