类注释

类的头文件中，对类的成员函数、成员变量做说明。

• 对于每个成员函数和成员变量，提供清晰的注释，说明其用途和行为。
• 使用标准的注释标记，如Java的/** ... */，以便于文档生成工具解析。
• 对于公共接口，详细说明参数和返回值；对于私有成员，说明其存在的理由和用途。

示例

/**
 * @class Rectangle
 * @brief 表示一个矩形的类。
 */
class Rectangle {
private:
    /**
     * @brief 矩形的宽度。
     */
    int width;

    /**
     * @brief 矩形的高度。
     */
    int height;

public:
    /**
     * @brief 构造函数，初始化矩形的宽度和高度。
     * @param w 矩形的宽度
     * @param h 矩形的高度
     */
    Rectangle(int w, int h) : width(w), height(h) {}

    /**
     * @brief 计算矩形的面积。
     * @return 矩形的面积，单位平方。
     */
    int area() const {
        return width * height;
    }

    /**
     * @brief 计算矩形的周长。
     * @return 矩形的周长，单位长度。
     */
    int perimeter() const {
        return 2 * (width + height);
    }
};