【代码注释】doxygen

1. 前言

没有注释的代码过了一段时间自己都看不懂😕这里推荐一款用得比较舒服的代码注释工具。

2. 下载

打开vscode，在应用市场中搜索 doxygen。

3. 操作简介

3.1 头部注释

在文件的头部，输入 /**后，按回车。

3.2 函数注释

在函数的头部，输入 /**后，按回车。

在 @brief 后面填上函数的功能。

4. 通过doxygen生成文档

可以通过doxygen应用程序生成文档，方便他人或自己查阅。

4.1 下载及安装

下载地址。

下载完成后安装，一路回车。

4.2 配置

4.2.1 配置工程

4.2.2 配置代码抽取及优化模式

4.2.3 配置文件输出

4.2.4 配置配图方案

4.3 生成文档

点击运行按钮，发现有报错，是因为之前选的路径中包含中文。

将源文件换个路径，不包含中文的地方。

生成文档成功后，可以看到多出两个文件夹。

如果在 4.2.3 选中了RTF选项的话，会多出一个文件夹，里面是比较详细的Word文档。

文档效果（配置工程的时候尽量不用选择图标，显示更和谐）：

5. 写在最后

doxygen在配置时有许多选项，可以多试试不一样的选项看效果。