小笔记：如何使用代码注释：关于JavaScript与TypeScript 注释和文档的自动生成
warning:
这篇文章距离上次修改已过190天，其中的内容可能已经有所变动。
/**
* 计算两个数的和
* @param {number} a 第一个加数
* @param {number} b 第二个加数
* @returns {number} 两数之和
*/
function add(a, b) {
return a + b;
}
// 使用
console.log(add(1, 2)); // 输出: 3这段代码展示了如何在JavaScript或TypeScript中使用JSDoc注释来描述一个函数的用途和参数，从而使得代码更具可读性和自文档性。注释以/**开始，并在需要文档化的函数、方法或变量上方添加。@param描述参数，@returns描述返回值。这样的注释可以被工具如TypeScript或编辑器如Visual Studio Code解析，以提供自动完成和快速信息。
评论已关闭