JSDoc 注释标记

以下是常用的 JSDoc 注释标记：

1. @param - 用于描述函数的参数。示例：@param {number} length - 矩形的长度

2. @returns - 用于描述函数的返回值。示例：@returns {number} - 矩形的面积

3. @typedef - 用于定义自定义类型别名。示例：@typedef {Object} Rectangle

4. @property - 用于描述对象属性。示例：@property {number} length - 矩形的长度

5. @description 或 @brief - 用于提供函数或对象的简短描述。示例：@description 计算矩形的面积

6. @example - 用于提供代码示例。示例：

   Copy Code
   /**
    * @example
    * var result = calculateArea(5, 10);
    * console.log(result); // 输出 50
    */
   

7. @throws 或 @exception - 用于描述函数可能抛出的异常。示例：@throws {Error} 如果参数无效，则抛出错误

8. @ignore - 用于忽略特定的注释块，使其不被 JSDoc 处理。