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;
}
相关推荐
爱写Bug的浮游1 小时前
C++移动构造真的比拷贝快吗
c++·性能优化
Aaa西红柿鸡蛋1 小时前
网络协议分析实验:基于 UDP 广播模型的 C/S 通信设计与实现
c++
青少儿编程课堂2 小时前
蓝桥杯·全国青少年信息素养大赛·电子学会Python/C++考级:扫描线与线段树求矩形面积并解析
c++·python·算法·bfs·信息学竞赛
eggwyw21 小时前
C++ union 的一种妙用法
开发语言·c++
ShineWinsu1 天前
对于Qt:QHBoxLayout常见属性以及方法的解析
c++·qt·面试·gui·客户端·布局管理器·水平布局器
小七在进步1 天前
string的实现(1)
c++·笔记·visual studio
敲上瘾1 天前
Qt核心机制:信号与槽详解
开发语言·c++·qt·ui·qt6.3
牢姐与蒯1 天前
cpp算法之哈希
c++·算法·哈希算法
lcj25111 天前
[C++] C++11
开发语言·c++·笔记
小小bugbug1 天前
带工作窃取的线程池
c++·线程池