JSDoc代码注释

在JavaScript中，JSDoc是一种用于为代码添加注释的工具，它可以帮助开发者生成详细的API文档。当函数或方法有返回值时，我们可以使用@return标签来描述返回值的相关信息。下面是一个完整的带有@return注释的JSDoc书写示例：

/**
 * @function addNumbers
 * @description 这个函数接收两个数字作为参数并返回它们的和。
 * 
 * @param {number} num1 - 第一个加数。
 * @param {number} num2 - 第二个加数。
 * 
 * @returns {number}
 * 返回两个数字的和。如果输入的不是数字或者没有输入参数，则返回NaN。
 */
function addNumbers(num1, num2) {
    if (typeof num1 !== 'number' || typeof num2 !== 'number') {
        return NaN;
    }
    return num1 + num2;
}

在上述例子中，

• @return 或者 @returns 标签用来描述函数的返回值。
• {number} 表示返回值的数据类型。
• 后面跟着的是对返回值详细、清晰的说明。

所以，一个规范的@return注释通常包含以下部分：

1. 标签名：@return 或 @returns
2. 返回值的数据类型
3. 返回值的详细描述

如果函数可能返回多种类型的值，你也可以在{}中用|分隔列出所有可能的类型，如{string|number}表示返回值可能是字符串或数字。