Doxygen

一、概述 Doxygen是一个代码文档生成工具。它从代码文件中提取注释并可生成多种文档形式。如：网页文档HTML，RTF (MS-Word)，PDF等等。同时也可生成函数之间的调用和文件的依赖关系图表。 二、安装 平台：linux sudo apt-get install doxygen sudo ......

前言 最近在工作的时候经常需要打包库，提供给到客户使用，在打包的过程中需要编写接口使用文档，之前都是自己一个接口一个接口重新编写的使用说明，感觉十分麻烦。在一次开会交流的时候，一个大佬推荐了我使用doxygen这个软件，仔细研究了一下发现，需要芯片厂，例如TI、ST等他们的使用文档都是通过这种方式来 ......

# 普通注释 一般普通注释中有详细注释和简要注释，简要注释有多种标识方法，**推荐使用`@brief`命令强制说明** ```cpp /** * @brief 简要注释. 详细注释 * 详细注释 */ ``` 简要注释结束的标志是一个点号，或一个空行。 # 文件头注释 ```cpp /** * @f ......

# 设置 ## 工具/选项/文本编辑器/`C/C++`/代码样式/常规  # 注释效果 ## 输入`/** ......

以@brief @param @return 等形式出现的注释标记被称为Doxygen注释标记（Doxygen Comment Tags）或者简称为Doxygen标记。 这玩意常用来作为接口文档说明或者接口源码注释，又比如EmmyLua用这个来作为lua函数的注释以提供智能提示。 常见的doxyge ......