如何在 VS Code 中为个人功能创建提示

Bob*_*bie 10 javascript intellisense typescript visual-studio-code

我想用我编写的所有 js 函数制作一个个人库。
我真正需要的是我需要 VS Code 的智能感知来向我展示关于这个函数的更多提示——输入变量的类型、返回的类型,也许是关于函数的一些信息。例如 - 子字符串的提示如下所示: 在此处输入图片说明
对我的函数的提示如下所示: 在此处输入图片说明

在 VS Code 中挖掘了一下,我发现有 .ts 文件,其中包含对象、接口和函数的声明(例如,lid.es6.d.ts 中的 substring() 声明等) 在此处输入图片说明
我的第一个想法是我是否可以制作一个包含我所有函数声明的个人 .ts 文件,并使智能感知也引用它。

Tit*_*mir 22

您的 javascript 函数不需要 .d.ts,您只需使用 jsDoc 注释即可。前任:

/**
 * Does stuff
 * @param {Number} params 
 */
function myFun(params) {


}
Run Code Online (Sandbox Code Playgroud)

之间{}是参数的类型。您还可以为您的函数添加描述。

VsCode 将选取 JsDoc 注释并使用它们向您显示提示。此外,如果您键入/**然后在函数上方按 Tab 键,它将根据您的函数插入一个属性格式的 jsDoc 注释,为您提供一个起点。

JsDoc 参考这里

注意:试试打字稿,你会得到你正在寻找的好提示,因为打字稿允许你指定参数类型,而且打字稿的输出是纯 TS,所以你可以在任何你可以使用的地方使用你的库它之前


san*_*oco 5

是的,您可以编写自己的打字。如果你不想使用TS,你可以使用JSDoc标准:

/**
 * Get a survey's details and possible answers by id
 * @param {Number} surveyId
 */ 
const getById = async (surveyId) => {
    ...
}
Run Code Online (Sandbox Code Playgroud)

VSC 足够智能,可以读取所有内容并在实施时显示出来。特别是当您构建导出和导入的服务时,这非常有效。

JSDoc 信息:http://usejsdoc.org/about-getting-started.html