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;
}
相关推荐
xiaolang_8616_wjl2 小时前
c++文字游戏_闯关打怪2.0(开源)
开发语言·c++·开源
夜月yeyue2 小时前
设计模式分析
linux·c++·stm32·单片机·嵌入式硬件
无小道3 小时前
c++-引用(包括完美转发,移动构造,万能引用)
c语言·开发语言·汇编·c++
FirstFrost --sy5 小时前
数据结构之二叉树
c语言·数据结构·c++·算法·链表·深度优先·广度优先
Tanecious.5 小时前
C++--map和set的使用
开发语言·c++
Yingye Zhu(HPXXZYY)5 小时前
Codeforces 2021 C Those Who Are With Us
数据结构·c++·算法
liulilittle6 小时前
LinkedList 链表数据结构实现 (OPENPPP2)
开发语言·数据结构·c++·链表
无聊的小坏坏6 小时前
三种方法详解最长回文子串问题
c++·算法·回文串
山河木马7 小时前
前端学习C++之:.h(.hpp)与.cpp文件
前端·javascript·c++
2401_891957317 小时前
list的一些特性(C++)
开发语言·c++