js 文档注释

/**
 * 这是一个简单的 JavaScript 函数，用于计算两个数字的和。
 *
 * @param {number} num1 - 第一个数字
 * @param {number} num2 - 第二个数字
 * @returns {number} 返回两个数字的和
 */
function addNumbers(num1, num2) {
    return num1 + num2;
}

/**
 * 这是一个类，表示一个矩形。
 */
class Rectangle {
    /**
     * 创建一个新的矩形对象。
     *
     * @param {number} width - 矩形的宽度
     * @param {number} height - 矩形的高度
     */
    constructor(width, height) {
        this.width = width;
        this.height = height;
    }

    /**
     * 计算矩形的面积。
     *
     * @returns {number} 返回矩形的面积
     */
    getArea() {
        return this.width * this.height;
    }
}

解释说明：

1. 函数注释：在 addNumbers 函数前使用了 JSDoc 格式的注释。它描述了函数的功能、参数类型以及返回值类型。
2. 类注释：在 Rectangle 类及其构造函数和方法前也使用了类似的注释，描述了类的用途、构造函数的参数以及方法的功能和返回值。

这种文档注释不仅有助于代码的可读性，还可以被一些工具（如 IDE 或文档生成器）解析，从而提供更好的开发体验。