C++复习笔记--C++常用注释规范

目录

1--常用注释规范

2--代码实例


1--常用注释规范

① @brief 表示简介,用于简单介绍函数或类的作用和功能;

② @param 表示参数,用于介绍和说明函数或类的参数;

③ @return 表示返回类型,用于说明函数的返回类型;

④ @author 表示作者,用于介绍作者信息;

⑤ @data 表示日期,用于介绍日期信息;

⑥ @version 表示版本,用于介绍版本信息;

⑦ @exception 用于说明可能引起的异常信息;

⑧ @property 表示属性,用于说明属性信息;

⑨ @retval 表示返回值,用于说明返回值的意义(例如可以说明 -1 表示异常)

2--代码实例

可以利用 /** */ 来区域性地进行注释,也可以利用 /// 来进行单个注释;

cpp 复制代码
#include <iostream>

int my_func1(int param1, int param2){
/**
    @brief A function that calculates the sum of two input integers.
    @param param1: The input interger.
    @param param2: The other input interger.
    @return int.
    @author liujinfu.
    @date 2023.09.15.
    @version 1.0.
*/
    return param1 + param2;
}

int my_func2(int param1, int param2){

/// @brief A function that calculates the sum of two input integers.
/// @param param1: The input interger.
/// @param param2: The other input interger.
/// @return int.
/// @author liujinfu.
/// @date 2023.09.15.
/// @version: 1.0.

    return param1 + param2;
}

int main(int argc, char* argv[]){
    int a = 1, b = 2;
    int c = my_func1(a, b);
    std::cout << c << std::endl;
    return 0;
}
相关推荐
感哥2 小时前
C++ 面向对象
c++
沐怡旸4 小时前
【底层机制】std::shared_ptr解决的痛点?是什么?如何实现?如何正确用?
c++·面试
感哥10 小时前
C++ STL 常用算法
c++
saltymilk20 小时前
C++ 模板参数推导问题小记(模板类的模板构造函数)
c++·模板元编程
感哥21 小时前
C++ lambda 匿名函数
c++
沐怡旸1 天前
【底层机制】std::unique_ptr 解决的痛点?是什么?如何实现?怎么正确使用?
c++·面试
感哥1 天前
C++ 内存管理
c++
博笙困了1 天前
AcWing学习——双指针算法
c++·算法
感哥1 天前
C++ 指针和引用
c++
感哥2 天前
C++ 多态
c++