面试题：JavaScript中函数注释如何规范用于文档生成

Question

请阐述在JavaScript中，使用JSDoc风格对函数进行注释的基本语法和规范，以实现自动文档生成。并举例说明一个简单函数的注释写法，包括参数说明、返回值说明。

Answer 1

JSDoc风格注释基本语法和规范

1. 函数注释结构：使用/** ... */块注释来包裹函数注释。
2. 描述：第一部分通常是对函数功能的简要描述。
3. 参数说明：使用@param标签，格式为@param {类型} 参数名 描述，类型可以是JavaScript的基本类型（如string、number等）或自定义类型。
4. 返回值说明：使用@returns或@return标签，格式为@returns {类型} 描述 。

示例

/**
 * 计算两个数的和
 * @param {number} num1 - 第一个数字
 * @param {number} num2 - 第二个数字
 * @returns {number} 两数之和
 */
function add(num1, num2) {
    return num1 + num2;
}