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;
}
相关推荐
胖大和尚39 分钟前
clang 编译器怎么查看在编译过程中做了哪些优化
c++·clang
钱彬 (Qian Bin)2 小时前
一文掌握Qt Quick数字图像处理项目开发(基于Qt 6.9 C++和QML,代码开源)
c++·开源·qml·qt quick·qt6.9·数字图像处理项目·美观界面
双叶8362 小时前
(C++)学生管理系统(正式版)(map数组的应用)(string应用)(引用)(文件储存的应用)(C++教学)(C++项目)
c语言·开发语言·数据结构·c++
源代码•宸3 小时前
C++高频知识点(二)
开发语言·c++·经验分享
jyan_敬言4 小时前
【C++】string类(二)相关接口介绍及其使用
android·开发语言·c++·青少年编程·visual studio
liulilittle4 小时前
SNIProxy 轻量级匿名CDN代理架构与实现
开发语言·网络·c++·网关·架构·cdn·通信
tan77º5 小时前
【Linux网络编程】Socket - UDP
linux·服务器·网络·c++·udp
GiraKoo6 小时前
【GiraKoo】C++14的新特性
c++
悠悠小茉莉6 小时前
Win11 安装 Visual Studio(保姆教程 - 更新至2025.07)
c++·ide·vscode·python·visualstudio·visual studio
坏柠6 小时前
C++ Qt 基础教程:信号与槽机制详解及 QPushButton 实战
c++·qt