2021-02-01

头文件加注释：
晚上做核酸检测

源文件添加备注步骤：
一、安装软件AutoComment自动添加C语言源码备注，手工添加备注
备注描述内容：
1、结构体功能、成员变量
2、函数功能
3、函数返回状态、返回值
4、全局变量
5、函数调用的外部函数
6、描述函数的执行过程及算法
二、安装Doxywizard软件，生成说明文件
1、块注释建议统一使用/……*/，行注释建议统一使用///< …或 / …… */
2、@后面跟的是doxygen定义的关键字，不是自定义的函数名前面加@，只能这样写 @brief @param …
三、调整生成的文件

查看代码：
1、ifndef：#ifndef起到的效果是防止一个源文件两次包含同一个头文件，而不是防止两个源文件包含同一个头文件。
格式：
#ifndef <标识>
#define <标识>

......
......

#endif

2、#include
多线程
g_mutex.lock();//你访问的变量，在你访问期间，别人访问不了
g_mutex.unlock();//解锁
std::thread t1(goA, 1);
3、extern关键字作用：extern用在变量或者函数的声明前，用来说明“此变量/函数是在别处定义的，要在此处引用，extern声明不是定义，即不分配存储空间。也就是说，在一个文件中定义了变量和函数， 在其他文件中要使用它们， 可以有两种方式：使用头文件，然后声明它们，然后其他文件去包含头文件；在其他文件中直接extern
4、#include
多线程
p[i] = new std::thread(run, i);创建线程
5、using namespace std;extern声明不是定义，即不分配存储空间。也就是说，在一个文件中定义了变量和函数， 在其他文件中要使用它们， 可以有两种方式：使用头文件，然后声明它们，然后其他文件去包含头文件；在其他文件中直接extern

注释实例：
/** @brief reportHealthAlarm

• 上报设备故障报警
• @param info [IN,OUT]设备故障的报警信息.

•                    - Type: Json::Value.\n
  

•                    - Range: N/A.
  

• @return void
• @retval N/A
  */