给我一个C++ 类的说明注释模板
时间: 2023-04-09 20:03:20 浏览: 166
以下是一个C类的说明注释模板:
/**
* @brief 该类实现了XXX功能。
*
* 该类包含了XXX属性和XXX方法,用于实现XXX功能。
*
*/
class C {
private:
int a; // 属性a用于XXX
float b; // 属性b用于XXX
public:
/**
* @brief 构造函数,用于初始化属性a和b。
*
* @param a 属性a的初始值
* @param b 属性b的初始值
*/
C(int a, float b);
/**
* @brief 方法1,用于实现XXX功能。
*
* @param x 参数x用于XXX
* @return 返回值用于XXX
*/
int method1(int x);
/**
* @brief 方法2,用于实现XXX功能。
*
* @param y 参数y用于XXX
* @return 返回值用于XXX
*/
float method2(float y);
};