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;
}
相关推荐
派阿喵搞电子38 分钟前
在UI界面内修改了对象名,在#include “ui_mainwindow.h“没更新
c++·qt·ubuntu·ui
C++ 老炮儿的技术栈2 小时前
UDP 与 TCP 的区别是什么?
开发语言·c++·windows·算法·visual studio
mochensage3 小时前
CSP信奥赛C++常用系统函数汇总
c++·信奥
mochensage3 小时前
C++信息学竞赛中常用函数的一般用法
java·c++·算法
fpcc3 小时前
跟我学c++中级篇——多线程中的文件处理
c++
5:004 小时前
云备份项目
linux·开发语言·c++
乄夜5 小时前
嵌入式面试高频(5)!!!C++语言(嵌入式八股文,嵌入式面经)
c语言·c++·单片机·嵌入式硬件·物联网·面试·职场和发展
YYDS3145 小时前
C++动态规划-01背包
开发语言·c++·动态规划
wydaicls6 小时前
十一.C++ 类 -- 面向对象思想
开发语言·c++
姜君竹6 小时前
QT的工程文件.pro文件
开发语言·c++·qt·系统架构