ts 文档注释怎么定义类型
在 TypeScript 中,可以使用 JSDoc 注释来定义类型。JSDoc 是一种在 JavaScript 代码中用于注释和文档化的标记语言,TypeScript 支持使用 JSDoc 注释来提供类型信息。
以下是一些常见的 JSDoc 注释用法来定义类型:
- 使用
@type标签来定义变量的类型:
/** @type {number} */
const num = 10;
- 使用
@param标签来定义函数参数的类型:
/**
* @param {string} name
* @param {number} age
*/
function greet(name, age) {
// ...
}
- 使用
@returns标签来定义函数返回值的类型:
/**
* @returns {string}
*/
function getName() {
// ...
}
- 使用
@typedef标签来定义自定义类型:
/**
* @typedef {Object} User
* @property {string} name
* @property {number} age
*/
/** @type {User} */
const user = { name: 'John', age: 25 };
- 使用
@callback标签来定义回调函数的类型:
/**
* @callback SuccessCallback
* @param {string} result
*/
/**
* @param {SuccessCallback} callback
*/
function fetchData(callback) {
// ...
}
这些是一些常见的 JSDoc 注释用法,可以根据需要灵活使用来提供类型信息。然而,建议在 TypeScript 中直接使用 TypeScript 的类型注解来定义类型,因为它们更加严格和类型安全
原文地址: http://www.cveoy.top/t/topic/iSJp 著作权归作者所有。请勿转载和采集!