如何将内联TypeScript注释用于常规JavaScript

Question

在VSCode中，您现在可以对普通JavaScript文件使用类型检查。有时我想在方法或函数上注释变量或参数的类型，这样我就可以更好地自动完成。

如何为javascript内联注释类型，以便从VSCode的类型检查和自动完成中受益？

示例

let classes = { class1, class2, myClass };
// annotate here so it recognizes MyClass
const myClass = classes.myClass;
// hoping that someFunction or someProperty would autocomplete on myClass
myClass.someFunction();
myClass.someProperty;

Answer 1

使用纯JavaScript时没有内联TypeScript注释。

但是您可以使用JSDoc来注释您的JavaScript。TypeScript将学习这些打字，因此您可以完全受益于VSCode为普通JavaScript文件实现的类型检查系统。

示例

let classes = { class1, class2, myClass };
/** @type {MyClass} */
const myClass = classes.myClass;
// Now MyClass methods and properties will autocomplete
myClass.someFunction();
myClass.someProperty;

参考

以下是关于如何使用JSDoc对函数和变量进行注释的参考。

http://usejsdoc.org/tags-type.html