目录
一、背景
随着 Typescript 的不断发展，很多流行的公共库（譬如 react、Lodash、axios）都为自己编写了类型文件，以便 TypeScript 用户能够更好地使用它们的 API。
在使用这些库时，你可以通过安装它们的 npm 包来自动获取相应的类型定义文件，或者手动下载和管理类型定义文件，以便在 TypeScript 项目中正确地使用这些库的 API。
总之，为你的 npm 包添加类型定义可以让使用方在编码时获得更好的 IDE 支持和代码提示，提高代码的可读性和可维护性。
二、如何添加类型定义支持智能提示
下面我将介绍两种常见的方法来为 npm 工具包添加类型定义：使用 TypeScript 编写类型声明文件和使用 JSDoc 注释。
方法一：使用 JSDoc 注释
JSDoc 是 JavaScript 的一种文档注释格式，用于描述代码的结构、功能和类型信息。它允许开发者在代码中使用特定的注释语法来提供对函数、变量、类等元素的描述，以及参数类型、返回值类型等信息。JSDoc 注释以 /** ... */ 的形式出现在代码的顶部，通常用于生成文档和提供代码提示。
以下是一个简单的 JSDoc 注释的示例：
/**
* 计算两个数的和
* @param {number} a 第一个数字
* @param {number} b 第二个数字
* @returns {number} 两个数的和
*/
function add(a, b) {
return a + b;
}
在这个示例中，我们使用 JSDoc 注释来描述了 add 函数的功能和参数信息。具体来说：
@param {number} a：指定了a参数的类型为number，表示第一个数字。@param {number} b：指定了b参数的类型为number，表示第二个数字。@returns {number}：指定了函数的返回值类型为number，表示两个数字的和。
当然，除了函数之外，JSDoc 注释也可以用于注释其他类型的代码元素，比如变量、类、方法、属性等。示例：
- 变量：
/**
* 表示人的姓名
* @type {string}
*/
const name = 'John';
- 类：
/**
* 表示一个人的类
* @class
*/
class Person {
/**
* 创建一个人的实例
* @param {string} name 人的姓名
*/
constructor(name) {
this.name = name;
}
/**
* 获取人的姓名
* @returns {string} 人的姓名
*/
getName() {
return this.name;
}
}
- 属性：
/**
* 表示一个人的年龄
* @type {number}
*/
Person.prototype.age = 30;
这些是一些常见的其他类型代码元素的 JSDoc 注释示例。通过使用 JSDoc 注释来描述代码的结构、功能和类型信息，可以使代码更易于理解和维护，并且提供更好的 IDE 支持和代码提示。
通过使用 JSDoc 注释，开发者可以提供代码的清晰文档，同时帮助 IDE 和其他工具生成更好的代码提示和自动补全，提高开发效率。JSDoc 注释可以与各种 JavaScript 开发工具和框架一起使用，包括 Visual Studio Code、Eclipse、WebStorm 等。
另外，还记得我们在
标签：Typescript,代码,number,注释,HOW,JSDoc,使用,类型,声明 From： https://blog.csdn.net/weixin_58540586/article/details/137460898