C/C++函数注释标准

C/C++函数注释

/**
 * @brief 进行两个整数相加的函数
 *
 * 该函数接收两个整数作为参数，并返回它们的和
 *
 * @param num1 第一个整数
 * @param num2 第二个整数
 * @return 两个整数的和
 *
 * @note 请保证输入的参数类型正确
 */
int add(int num1, int num2) {
    return num1 + num2;
}