如何在 VS Code 中为个人功能创建提示
How to create hints for personal functions in VS Code
我想用我所有的js函数编写一个个人库。
我真正需要的是我需要 VS Code 的智能感知来向我展示有关此函数的更多提示 - 输入变量的类型,return 的类型,也许是有关该函数的一些信息。
例如 - 子字符串的提示如下所示:
我的功能提示如下所示:
在 VS Code 中深入挖掘,我发现有 .ts 文件包含对象、接口和函数的声明(例如 substring() in lid.es6.d.ts 等的声明)
我的第一个想法是我是否可以创建一个包含所有函数声明的个人 .ts 文件,并让智能感知也引用它。
您的 javascript 函数不需要 .d.ts,您可以只使用 jsDoc 注释。例如:
/**
* Does stuff
* @param {Number} params
*/
function myFun(params) {
}
在{}
之间是参数的类型。您还可以为您的函数添加描述。
VsCode 将提取 JsDoc 注释并使用它们向您显示提示。此外,如果您键入 /**
然后在函数上方按 Tab 键,它将根据您的函数插入一个 属性 格式的 jsDoc 注释,为您提供一个起点。
JsDoc 参考 here
注意:试试 typescript,你会得到你正在寻找的很好的提示,因为 Typescript 允许你指定参数类型,而且 typescript 的输出是纯 TS ,因此您可以在
之前可以在任何地方使用您的图书馆
是的,您可以编写自己的打字。如果不想用TS,可以用JSDoc标准:
/**
* Get a survey's details and possible answers by id
* @param {Number} surveyId
*/
const getById = async (surveyId) => {
...
}
VSC 足够智能,可以读取所有内容并在实施时显示出来。
特别是当您构建导出和导入的服务时,效果很好。
我想用我所有的js函数编写一个个人库。
我真正需要的是我需要 VS Code 的智能感知来向我展示有关此函数的更多提示 - 输入变量的类型,return 的类型,也许是有关该函数的一些信息。
例如 - 子字符串的提示如下所示:
我的功能提示如下所示:
在 VS Code 中深入挖掘,我发现有 .ts 文件包含对象、接口和函数的声明(例如 substring() in lid.es6.d.ts 等的声明)
我的第一个想法是我是否可以创建一个包含所有函数声明的个人 .ts 文件,并让智能感知也引用它。
您的 javascript 函数不需要 .d.ts,您可以只使用 jsDoc 注释。例如:
/**
* Does stuff
* @param {Number} params
*/
function myFun(params) {
}
在{}
之间是参数的类型。您还可以为您的函数添加描述。
VsCode 将提取 JsDoc 注释并使用它们向您显示提示。此外,如果您键入 /**
然后在函数上方按 Tab 键,它将根据您的函数插入一个 属性 格式的 jsDoc 注释,为您提供一个起点。
JsDoc 参考 here
注意:试试 typescript,你会得到你正在寻找的很好的提示,因为 Typescript 允许你指定参数类型,而且 typescript 的输出是纯 TS ,因此您可以在
之前可以在任何地方使用您的图书馆是的,您可以编写自己的打字。如果不想用TS,可以用JSDoc标准:
/**
* Get a survey's details and possible answers by id
* @param {Number} surveyId
*/
const getById = async (surveyId) => {
...
}
VSC 足够智能,可以读取所有内容并在实施时显示出来。 特别是当您构建导出和导入的服务时,效果很好。